Skip to content
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

Add user guide #758

Open
cliffckerr opened this issue Nov 12, 2024 · 1 comment
Open

Add user guide #758

cliffckerr opened this issue Nov 12, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@cliffckerr
Copy link
Contributor

In addition to the API and tutorials, we should have a user guide that explains things like:

  • Starsim architecture (interactions between networks, diseases, etc)
  • Implementation details (e.g. performance optimizations like Numba and arrays)
  • What's needed to build a model (states, parameters, etc)
  • More detail on the individual "spokes"

Challenge is to figure out how to sensibly split this content between the user guide and tutorials.

Examples:

@cliffckerr cliffckerr added this to the Version 2.x milestone Nov 13, 2024
@cliffckerr cliffckerr modified the milestones: Version 2.x, Version 2.3.1 Dec 11, 2024
@cliffckerr
Copy link
Contributor Author

Related to #815

@cliffckerr cliffckerr added the documentation Improvements or additions to documentation label Dec 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant