Skip to content

Create paramaters-description.md #329

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.

Sign up for GitHub

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

Open
derekwinton wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Create paramaters-description.md #329

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b93c4cf
Create paramaters-description.md
derekwinton May 23, 2020
8e94131
Update and rename paramaters-description.md to parameters-description.md
derekwinton May 23, 2020
738d19d
Update parameters-description.md
derekwinton May 23, 2020
f036860
Update parameters-description.md
derekwinton May 25, 2020
c242c36
Update parameters-description.md
derekwinton May 25, 2020
37df639
Update parameters-description.md
derekwinton May 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
217 changes: 217 additions & 0 deletions docs/parameters-description.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,217 @@
# Parameters

WIP - interpretations below are based on reading the SetupModel.cpp file

The parameters class contains:
- configurable options for running the simulation
- quantitative information used in the simulation
- data produced about the setup process e.g. running totals
- variables used to load/save information
- variable used to manage processor / memory

Note : Click the arrow next to each item to expand

## Configurable Options
<details>
<summary>Boolean - on/off options</summary>

A value of '1' for the given variable turns that option 'on'

| Variable | Description |
| --------------- | --------------- |
| DoBin | |
| DoHeteroDensity | read population density info from file |
| DoAdUnits | use administrative units |
| DoAdUnitBoundaries | |
| DoPlaces | turn on 'places' functionality |
| DoSpecifyPop | Specify number of hosts (given by PopSize variable) |
| DoAirports | turn on 'airports' functionality |
| DoInitUpdateProbs | |
| DoDigitalContactTracing | use digital contact tracing |
| ClusterDigitalContactUsers | cluster users of digital contact tracing by household |
| DoSI | |
| DoMassVacc | implement mass vaccination programme prioritised by age |
| EnhancedSocDistClusterByHousehold | |
| LocalBeta | |
| OutputBitmap | generate bitmap file of results |
| DoPlaceGroupTreat | |
| | |



</details>

<details>
<summary>Variables related to Places</summary>

| Variable | Description |
| --------------- | --------------- |
| NPlace | number of places |
| PlaceTypeNum | number of place types |
| HotelPlaceType | index of element in places array corresponding to 'hotel' |
| PlaceTypeGroupSizeParam1[] | group size in given place type? |
| PlaceTypeTrans[] | transmission rate in given place type |
| SymptPlaceTypeContactRate[] | rate of those in given place type displaying symptoms who will use contact tracing? |
| SymptPlaceTypeWithdrawalProp[] | |
| PlaceTypePropBetweenGroupLinks[] | |
| PlaceTypeSizePower[] | |
| PlaceTypeSizeSD[] | Standard deviation in size of given place type |
| PlaceTypeMeanSize[] | Mean size of given place type |
| PlaceTypeSizeOffset[] | |
| PlaceTypeSizeMax[] | Maximum size of given place type |
| PlaceTypeNearestNeighb[] | |
| PlaceTypeMaxAgeRead[] | Maximum age of person that can be assigned to this place? |
| | |
| | |

</details>

<details>
<summary>Variables related to administrative units</summary>

| Variable | Description |
| --------------- | --------------- |
| AdunitLevel1Mask | |
| AdunitLevel1Divisor | |
| AdunitLevel1Lookup | |
| | |
</details>


<details>
<summary>Variables related to cells and micro-cells</summary>

| Variable | Description |
| --------------- | --------------- |
| NC | total number of cells |
| ncw | number of columns in grid of cells |
| nch | number of rows in grid of cells |
| NMC | total number of micro-cells - calculated as function of number of cells and cells per microcell |
| NMCL | number of micro-cell columns in each cell (squared to give number of micro-cells) |
| nmcw | number of micro-cell columns in cell |
| nmch | number of micro-cell rows in cell |
| | |
</details>

<details>
<summary>Random seeds</summary>

| Variable | Description |
| --------------- | --------------- |
| setupSeed1 | |
| setupSeed2 | |
| nextSetupSeed1 | |
| setupSeed2 | |
| | |

</details>

## Quantitative information

<details>
<summary>Information about the virus</summary>

| Variable | Description |
| --------------- | --------------- |
| AgeInfectiousness[] | infectiousness values for given age group |
| ProportionSymptomatic[] | proportion of those that display symptoms for given age group |
| infectiousness[] | |
| SymptInfectiousnes | infectiousness rate when symptomatic |
| InfectiousPeriod | amount of time an infected host is infectious for |
| SymptSpatialContactRate | |
| infectious_icdf | |
| LatentToSymptDelay | |
</details>

<details>
<summary>Information about the population</summary>

| Variable | Description |
| --------------- | --------------- |
| EnhancedSocDistProportionCompliant[] | proportion of given age group likely to comply with social distancing |
| ProportionSmartphoneUsersByAge[] | proportion of population of that age that use smart phones - used to determine likelihood of a person of a given age using a smart phone and in turn digital contact tracing |
| RelativeSpatialContact[] | |
| PopSize | number of hosts |
| PropPopUsingDigitalContactTracing | proportion of population using digital contact tracing |
</details>

<details>
<summary>Information about response measures</summary>

| Variable | Description |
| --------------- | --------------- |
| VaccPriorityGroupAge[] | array containing two elements: the min and max age for vaccination priority group |
| VaccProp | proportion of population to be vaccinated |
| | |
| | |

</details>

## Data produced about setup process

<details>
<summary>Running totals</summary>

| Variable | Description |
| --------------- | --------------- |
| NDigitalContactUsers | Count of number of digitabl contact tracing app users |
| NDigitalHouseholdUsers | Count of househods using digital contact tracing app |
| | |
| | |
| | |
</details>

## Variables used to load / save information

<details>
<summary>Bitmap loading / saving</summary>

| Variable | Description |
| --------------- | --------------- |
| SpatialBoundingBox[] | array of four elements - starts large then adjusted to immediately surround x,y |
| width | width of calculated spatial bounding box - SpatialBoundingBox[2] - SpatialBoundingBox[0]. for non-heterodensity, width = squre root of population size? |
| height | height of calculated spatial bounding box - SpatialBoundingBox[3] - SpatialBoundingBox[1]. for non-heterodensity, width = squre root of population size? |
| CountryDivisor | |
| LongitudeCutLine | |
| BinFileLen | number of lines in input file - used for file reading |
| BinFileBuf | contents of input file - used for file reading |
| BitmapScale | x-scale |
| BitmapAspectScale | aspect ratio of bitmap |
| scalex | |
| scaley | |
| bwidth | bitmap width |
| bheight | bitmap height |
| bheight2 | bheight + 20 to shift above legend |
| | |
| | |
| | |
</details>

<details>
<summary>Memory / processor management</summary>

| Variable | Description |
| --------------- | --------------- |
| KernelShape | |
| KernelScale | |
| KernelP3 | |
| KernelP4 | |
| KernelType | |
| MoveKernelShape | |
| MoveKernelScale | |
| MoveKernelP3 | |
| MoveKernelP4 | |
| MoveKernelType | |
| | |
| | |
| | |
</details>


<details>
<summary></summary>

| Variable | Description |
| --------------- | --------------- |
| | |
</details>