-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weβll occasionally send you account related emails.
Already on GitHub? Sign in to your account
π Epic: Internal Ersilia statistics #65
Comments
Please use the appropriate repository for each issue. This needs to be moved to Ersilia-stats |
Hi @itsjackfan and team, I've had an in-depth look into the README file generated on the 25th of December, 2024. It looks great overall! This is going to be so useful. Below, I make a relatively long list of comments. I hope they help. Feel free to address the ones that sound reasonable/feasible.
I hope this is useful. Please do not be overwhelmed by this list. It is OK if we can only address some of the comments. Thanks! |
Actions for the Ersilia Stats repository β internal data
The ersilia-stats repository is aimed at collectiing statistics that are relevant to demonstrate the impact of the Ersilia Open Source Initiative. Broadly speaking, and as initially outlined in the GDI Hackathon (2024), we have 2 types of statistics: (a) internal and (b) external. Let's start with internal data.
The idea is that a set of GitHub Actions jobs will run on a periodic basis and some statistics will be produced.
Below, I am listing what the jobs should do. This can be done in one single YAML workflow file or in multiple files, as you see fit.
Job 1: Fetch Airtable data and save as CSV
We have two bases in Airtable, namely Ersilia Model Hub and Content.
The Content base
In the Content base, there are multiple tables that we need to export. For now, let's start with the following:
The Ersilia Model Hub base
This base contains a registry of the models available in the Ersilia Model Hub. We should fetch the following table:
Steps
ersilia-stats/data/
folder in the repository.Job 2: Calculate statistics
ersilia-stats/data/
folder, calculate relevant statistics. This is a relatively open-ended job. There are many statistics that we can potentially calculate. Let's synchronize this with the dashboard produced by our UX design Berkeley collaborators.To get an idea, below are some stats that we might want to calculate:
Publications
Blogposts
Community
Events
Note: This table can possibly be improved.
Repositories
Models
Job 3: Write report in the README file and as a JSON file
ersilia-stats/reports/tables_stats.json
file. Let's define a good schema for this JSON file, using lower-case in the fields and hyphens to separate words. For example,total-models
ortotal-models-current-quarter
.ersilia-stats/README.md
file that contains the statistics in a nice Markdown layout. The structure of thisREADME.md
file is open for discussion. In my opinion, the README file should contain the statistics and more (for example, a short text about Ersilia, a thank-you note to the community members, a line explaining when were the statistics collected, etc.).Final remarks
Objective(s)
Calculate internal statistics for Ersilia based on data available in Airtable. The work should be incorporated in the ersilia-stats repository and should use Github Actions workflows.
Documentation
The text was updated successfully, but these errors were encountered: