Outreachy Documentation Project: itsmedeepak

[itsmedeepak]

Applicant: @itsmedeepak

Welcome to the Ersilia Open Source Initiative. This issue will serve to track all your contributions for the project “Improve the documentation and outreach material of the Ersilia Model Hub”.

Please tick the tasks as you complete them. To make a final application it is not required to have completed all tasks. Only the Initial Steps and Community sections are REQUIRED. The tasks are not ordered from more to less important, they are simply related to different skills. Start where you feel most comfortable. This project can be adapted to the applicants interests, please focus on the type of tasks that you prefer / have better skills / would like to work on as an intern.

---

Initial steps:

• [ ] Record your application for the project in the outreachy website referencing this issue. Please make sure to select the right project on the website.
• [x] Join the Slack channel to follow public communications

• [ ] Comment under this issue explaining why are you interested in this project

  GitHub documentation:

• [x] Create a README file with the name under the /documentation folder
• [x] Link the #PR in a comment under this issue

• [ ] Incorporate feedback from the mentor

  Writing dissemination material

• [ ] Read the Strategic plan 2021-2023 for Ersilia and create a 1-page blogpost with the main points
• [ ] Comment under this issue with a link to the blogpost (a google docs for example)
• [ ] Incorporate feedback from the mentor
• [ ] Choose your own topic related to Ersilia (AI/ML for biomedical research, neglected diseases, drug discovery…) and write a 1-page blogpost to communicate to a non-expert audience
• [ ] Comment under this issue with a link to the blogpost (a google docs for example)
• [ ] Incorporate feedback from the mentor
• [ ] Create a template for a twitter post to release every time a new model is incorporated in the Hub (twitter: 280 characters, you can suggest a main post + thread with extra information) and add it as a comment under this issue

• [ ] Create a template short Newsletter (1 paragraph) to send every month to our community (funders, users, contributors). It should mention metrics (models in the hub, number of users, funding…), thank you etc

  Technical skills (required for the tutorial only)

• [ ] Install the Ersilia Model Hub
• [ ] Test one model
• [ ] Add a screenshot under this issue showing the model running in your computer

• [ ] Write a docstring for the ErsiliaModel class. Use the Google Python Style guide. Paste the docstring as a comment below (do not use a PR).

  Graphic material

• [x] Read the Ersilia Brand Guidelines
• [x] Read “Why Ersilia?”
• [ ] Create one image / slide to explain Ersilia’s mission and vision
• [ ] Link to the image/slide as a comment under this issue
• [ ] Incorporate feedback from the mentor
• [ ] Create two slides / short video showing how to use the Ersilia Model Hub and add them under the /tutorial folder
• [ ] Link the #PR in this issue

• [ ] Incorporate feedback from the mentor

  Scientific content

• [ ] Check the models available in the Hub
• [ ] Select one model from the list and write a technical card (what is the model for, what input, which data was used to create it, what kind of ML algorithm uses…) for it
• [ ] Add your card as a comment to this issue

• [ ] Search the scientific literature and suggest 3 new models (comment in this issue) that would be relevant to incorporate in the Hub.

  Community

• [ ] Look up two other projects and comment on their issues with feedback on one of their tasks

• [ ] If you have feedback from your peers, answer it in this issue.

  Other

  If you have interest in working on related topics, or have new suggestions, please do the following

• [ ] Add a comment in this issue with your new idea, tagging the mentor
• [ ] Get feedback from the mentor and act accordingly

• [ ] Link in the comments any other PR you have contributed to.

  Final application

• [ ] I have answered all comments from mentors and contributors
• [ ] All PR or issues assigned to me are complete
• [ ] I have submitted my final application to the project

[Dapper50]

@itsmedeepak Hi please assist put me through on how you created your Readmefile

[itsmedeepak]

@itsmedeepak Hi please assist put me through on how you created your Readmefile

Hey @Dapper50 just go through the readme.md file in root directory, clone it, change it as per your requirement...

[GemmaTuron]

Hi @itsmedeepak

You created a copy of the README file but I cannot see any additions or modifications. The goal of this task is to suggest changes in our readme file to make it better, more informative.. can you work on it? You can also choose a different task if you are more interested in another topic, browse the list above for ideas

[GemmaTuron]

Hi @itsmedeepak

New contributions to the project closed last week and we fail to see your application on the website

[GemmaTuron]

The Outreachy contribution period has come to an end, so I will close this issue. If you want to continue contributing to Ersilia, please follow the guidelines in the CONTRIBUTING file