Skip to content

Commit

Permalink
Readme update (#240)
Browse files Browse the repository at this point in the history
* updating quickstart instructions for readme

* adding mention of ode_model.md
  • Loading branch information
arik-shurygin authored Aug 27, 2024
1 parent 6b7dc11 commit 6f05a1b
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,15 @@ Subject to change, current transmission dynamics follow this basic model

## Quick Start

As a first pass at running model ODEs and inference of parameters, take a look at `example_end_to_end_run.py` to see the process of running our model. You will probably need to `pip install -r requirements.txt` to get started as well.
As a first pass at running model ODEs and inference of parameters, take a look at `example_end_to_end_run.py` to see the process of running our model. You will probably need to `poetry install` to get started as well.

Within `example_end_to_end_run.py` there is an optional `-infer` flag added from the terminal. This will kick off an example inference on synthetic data generated by the model itself and will produce different output.
Within `example_end_to_end_run.py` there is an optional `--infer` flag added from the terminal. This will kick off an example inference on synthetic data generated by the model itself and will produce different output.

To try out your own basic scenarios, check out the `config/` folder, where you can modify parameters within the four base `json` files as you see fit and see their impacts on the model back at `example_end_to_end_run.py`.

If you are interested in understanding how the model is initialized, rather than looking through the model matricies yourself, the Scenarios team has created a Shiny application allowing for easy data visualization of the model's initial state! Simply run `visualizer_app.py` and navigate to http://localhost:8000/ and play with the data yourself.
If you are interested in understanding how the model is initialized, rather than looking through the model matricies yourself, the Scenarios team has created a Shiny application allowing for easy data visualization of the model's initial state! Simply run `shiny_visualizers/visualizer_app.py` and navigate to http://localhost:8000/ and play with the data yourself.

For a breakdown of the Ordinary Differential Equations at the heart of this model take a look at `ode_model.md`.

## Technical Details

Expand Down

0 comments on commit 6f05a1b

Please sign in to comment.