covid-sim
/home/abuild/rpmbuild/BUILD/covid-sim-0.14.0/data/README.md
1 # Data Directory and Samples
2 
3 This directory provides sample input data and an example script to run.
4 
5 **IMPORTANT**: The parameter files are provided as a sample only and do not
6 necessarily reflect runs used in published papers.
7 
8 ## Directories
9 
10 - *populations*: provides population density information
11 
12 - *admin_units*: specifies the administration units for each country
13 
14 - *param_files*: Provides sample parameter files
15 
16 ## Running the sample
17 
18 The file `./run_sample.py` will build and run a sample for a specified country.
19 
20 ### Usage
21 
22 ```sh
23 ./run_sample.py <COUNTRY>
24 ```
25 
26 For example:
27 
28 ```sh
29 ./run_sample.py United_Kingdom
30 ```
31 
32 This will:
33 
34 1. Build a copy of the CovidSim executable configured for the appropriate
35  country (in this case the UK)
36 
37 2. Do a no intervention base run. This run also provides various `*.bin`
38  files for the later run.
39 
40 3. Do a run with controls applied. This is the step to be repeated when
41  doing further tests/runs.
42 
43 The sample script has more command line options available. See
44 `./run_sample.py --help` for a list.