search

CDCgov / cfa-viral-lineage-model

Apache License 2.0
10 stars 0 forks source link

First-pass docs #7

Closed swo closed 2 months ago

swo commented 3 months ago 
          This is definitely _not_ something to pile into this PR (it's entirely separable and can be handled after merging), but some basic documentation would be good.

For example, after some poking around I can see that one should run python load_metadata.py before I try to run the simulations, and it would be good for the README to mention this.

Originally posted by @afmagee42 in https://github.com/CDCgov/cfa-viral-lineage-model/issues/6#issuecomment-2221205956

afmagee42 commented 2 months ago

While we will want to revisit documentation eventually, between #17 and the continuous improvement of README.md and present-day-forecasting/README.md, the docs are in sufficient shape for now. We can address the simulation study docs when we do #38.