Write documentation - Githubissues

starsimhub / starsim

Starsim disease modeling framework

http://starsim.org

MIT License

14 stars 8 forks source link

Write documentation #226

Closed cliffckerr closed 8 months ago

cliffckerr commented 8 months ago

Let's hold off on this a little longer until we've done a bit more on getting the code/API to a good place.

Docstrings

[ ] analyzers
[ ] connectors
[ ] demographics
[ ] disease
[ ] diseases.examples
[ ] diseases.gonorrhea
[ ] diseases.hiv
[ ] diseases.syphilis
[ ] distributions
[ ] interventions
[ ] modules
[ ] networks
[ ] parameters
[ ] people
[ ] products
[ ] random
[ ] results
[ ] settings
[ ] sim
[ ] states
[ ] utils

Basic docs pages

[ ] Overview
[ ] What's new
[ ] Contributing

User guide tutorials

[ ] U1 - Getting started
[ ] U2 - Plotting, printing, and saving
[ ] U3 - Running scenarios
[ ] U4 - Basic disease models
[ ] U5 - People, populations, and networks
[ ] U6 - Using interventions and analyzers
[ ] U7 - Calibration

Developer guide tutorials

[ ] D1 - Defining diseases
[ ] D2 - Defining networks
[ ] D3 - Defining interventions and analyzers
[ ] D4 - Understanding demographics
[ ] D5 - Understanding distributions

robynstuart commented 8 months ago

Closing in favor of more granular issues under https://github.com/amath-idm/starsim/milestone/11