Skip to content

Commit

Permalink
docs: add location prose
Browse files Browse the repository at this point in the history
  • Loading branch information
mcmcgrath13 committed May 12, 2021
1 parent 9e351d1 commit a8280d5
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/api/location.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,18 @@
Locations can be used in TITAN to differentiate agents by "geography". The primary features of locations are:

* Differentiated parameters via location scaling/overrides
- Allows different demographics or interventions by location
- See [params app for details](https://pph-collective.github.io/titan-params-app/#/params#location-1)
* Location based assorting (including based on neighboring locations)
- Can have agents assort with agents from their own location vs neighbors vs all others
- Neighboring locations are determined by the `edges` defined in `params.location`
- See [params app for details on assorting rules](https://pph-collective.github.io/titan-params-app/#/params#assort_mix-1)
- It is also possible to define edges via a geography CSV (see [utils](/api/utilities/#titan.utils.grid_file_to_edges)). This is also exposed via the `grid2edges` command line utility (run `grid2edges --help` for usage).
* Migration between locations
- When an agent migrates locations, they adopt the parameters of their new location
- Migration can cause the population numbers in a location to drift over time
- See [params app for details](https://pph-collective.github.io/titan-params-app/#/params#location-1)

## Location

::: titan.location.Location
Expand Down

0 comments on commit a8280d5

Please sign in to comment.