Skip to content

Commit

Permalink
doc(readme): prettify readme, correct some of the bugs
Browse files Browse the repository at this point in the history
  • Loading branch information
ivan-aksamentov committed Mar 28, 2020
1 parent 8b842f4 commit f76b74c
Showing 1 changed file with 77 additions and 44 deletions.
121 changes: 77 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,8 @@ Models of COVID-19 outbreak trajectories and hospital demand
</a>
</p>

---

<h2 align="center">
Got questions or suggestions?
</h2>
Expand All @@ -105,9 +107,10 @@ Got questions or suggestions?
</a>
</p>

---

<h2 align="center">
Discover
🔍 Discover
</h2>

<p align="center" width="99%">
Expand Down Expand Up @@ -175,7 +178,11 @@ Discover
</table>
</p>

### Overview
---

<h2 align="center">
👀 Overview
</h2>

This tool is based on an SIR model (see about page for details) that simulates a COVID19 outbreak. The population is
initially mostly susceptible (other than for initial cases). Individuals that recover from COVID19 are subsequently
Expand All @@ -188,78 +195,82 @@ etc. The effect of such measures can be included in the simulation by adjusting
you can explore the effect of isolation on specific age groups in the column "Isolated" in the table on severity
assumptions and age specific isolation.

### Parameters

Parameters fall into three different categories

- population parameters
- epidemiological parameters
- clinical parameters

Most parameters can be adjusted in the tool and for many of them we provide presets.
Most parameters can be adjusted in the tool and for many of them we provide presets (scenarios).

Input data for the tool and the basic parameters of the populations are collected in a separate repository
[neherlab/covid19_scenarios_data](https://github.com/neherlab/covid19_scenarios_data). Please add data on populations
and parsers of publicly available case count data there.

### User Guide
---

<h2 align="center">
📕 User's Guide
</h2>

The online application provides a friendly user interface with drop downs to choose model parameters, run the model, and export results in CSV format. A detailed process is below.

#### Population Parameters

### Parameters: population

Select the population drop down and select a country/region to auto-populate the model's parameters with respective UN population data. These parameters can be indivdually updated manually if necessary.

#### Epidemiology Parameters

The preset epidemiology parameters are a combination of speed and region - specifying growth rate, seasonal variation, and duration of hospital stay. To choose a preset distribution, select one of the options from the epidemiology drop down to auto-populate the model's parameters with the selected parameters.
### Parameters: epidemiology

The epidemiology parameters are a combination of speed and region - specifying growth rate, seasonal variation, and duration of hospital stay. To choose a preset distribution, select one of the options from the epidemiology drop down to auto-populate the model's parameters with the selected parameters.

#### Mitigation Parameters

Mitigation parameters represent the reduction of transmission through mitigation measures over time. To select a preset, click on the mitigation dropdown and select one of the options. Otherwise, the points on the graph can be dragged and moved with the mouse. The parameter ranges from one (no infection control) to zero (complete prevention of all transmission).
### Parameters: mitigation

#### Running the Model
Mitigation parameters represent the reduction of transmission through mitigation (infection control) measures over time. To select a preset, click on the mitigation dropdown and select one of the options. Otherwise, the points on the graph can be dragged and moved with the mouse. The parameter ranges from one (no infection control) to zero (complete prevention of all transmission).

### Running the Model

Once the correct parameters are inputted, select the run button located in the Results section of the application. The model output will be displayed in 2 graphs: Cases through time and Distribution across groups and 2 tables: Populations and Totals/Peak.

#### Exporting Results
### Exporting Results


The model's results can be exported in CSV format by clicking the "export" button in the right hand corner.

---

<h2 align="center">
🖥️ Development
</h2>

### Development
### Quick Start

#### Install Requirements

- Node >= 10
- Git 2.0+
- Node >= 10+
- Yarn 1.x

#### Quick Start

This will run the application in development mode (with hot reloading):
Then in your terminal type:

```bash
git clone https://github.com/neherlab/covid19_scenarios
git clone --recursive https://github.com/neherlab/covid19_scenarios
cd covid19_scenarios/
cp .env.example .env
yarn install
yarn dev

```

This will trigger the development server and build process. Wait for the build to finish, then navigate to
`http://localhost:3000` in a browser (last 5 version of Chrome or Firefox are supported in dev mode)
(on Windows, substitute `cp` with `copy`)

Hit Ctrl+C in the terminal to shutdown.
This will trigger the development server and build process. Wait for the build to finish, then navigate to
`http://localhost:3000` in a browser (last 5 versions of Chrome or Firefox are supported in development mode).

> ℹ️ Hint: type "rs<Enter>" in terminal to restart the build
#### Architecture
TODO
> ℹ️ Hit Ctrl+C in to shutdown the server

#### Directory Structure
### Directory Structure

As a developer you are most likely interested in the actual source code in src/. The structure of /src is shown below.
As a developer you are most likely interested in the actual source code in `src/` directory.

| File or directory | Contents |
| ----------------- | --------------------------------------------------------------------------------- |
Expand Down Expand Up @@ -307,38 +318,56 @@ As a developer you are most likely interested in the actual source code in src/.

### Production build

TODO
In order to replicate the production build locally, use this command:

### Release Build
```bash

TODO
yarn prod:watch

```

This should build the application in production mode and to start static server that will serve the app on `http://localhost:8080` (by default)

### Continuous integration and deployment

### Release ccycle, continuous integration and deployment

TODO


### Getting Started

For new contributers, follow the guide below to learn how to fork & clone, install required software, and submit changes using a pull request.
For new contributers, follow the guide below to learn how to install required software, fork & clone, and submit changes using a pull request.

#### ✨ Installing Required Software

1. Install Git by following GitHub's instructions [here](https://help.github.com/en/github/getting-started-with-github/set-up-git)

2. Node.js can be installed using nvm on [Mac/Linux](https://gist.github.com/d2s/372b5943bce17b964a79) and nvm-windows on [Windows](https://docs.microsoft.com/en-us/windows/nodejs/setup-on-windows).

3. Yarn can be globally installed following [these steps](https://classic.yarnpkg.com/en/docs/install/#mac-stable)

#### 🍴 Forking the Repo
Click the Fork button on the upper right-hand side of the repository’s page.

#### 👯 Clone Forked Repository
Clone this repo to your local machine using https://github.com/neherlab/covid19_scenarios.git

#### ✨ Installing Required Software
1. Node.js can be installed using nvm on [Mac/Linux](https://gist.github.com/d2s/372b5943bce17b964a79) and nvm-windows on [Windows](https://docs.microsoft.com/en-us/windows/nodejs/setup-on-windows).
2. Yarn can be globally installed following [these steps](https://classic.yarnpkg.com/en/docs/install/#mac-stable)
Clone this repository recursively (including submodules) to your local machine. You can use the URL of your repo inside git command, for example:

```bash
git clone --recursive https://github.com/<YOUR_GITHUB_USERNAME>/covid19_scenarios

```


#### 🔨 Start coding!

<img src="https://i.giphy.com/media/3oriO7A7bt1wsEP4cw/giphy.webp" />

#### 💻 Updating the Forked Repository
To ensure that the forked code stays updated, you’ll need to add a Git remote pointing back to the original repository and create a local branch.

```
git remote add upstream https://github.com/openvswitch/openvswitch.github.io.git
git remote add upstream https://github.com/neherlab/covid19_scenarios
```

To create and checkout a branch,
Expand All @@ -353,7 +382,11 @@ To create and checkout a branch,

To submit your code to the repository, you can [submit a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).

## Acknowledgements
---

<h2 align="center">
🙏 Acknowledgements
</h2>

### Initial development

Expand Down

1 comment on commit f76b74c

@vercel
Copy link

@vercel vercel bot commented on f76b74c Mar 28, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.