Skip to content

Commit

Permalink
Installation instructions. Related to #55
Browse files Browse the repository at this point in the history
  • Loading branch information
alephcero committed Jun 23, 2020
1 parent f480087 commit 0cd2a2e
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,15 @@ The paper is available here:
http://www.scag.ca.gov/Documents/PopulationSynthesizerPaper_TRB.pdf

.. _PopGen: http://urbanmodel.asu.edu/popgen.html

# Installation

```
virtualenv venv --python=python3.7
source venv/bin/activate
pip install -r requierements.txt
cd synthpop/
python setup.py develop
```
To run `Synthpop` you need a Census API that you can get one from [here](https://api.census.gov/data/key_signup.html). After you get and validate the API key you can add it as an enviromental variable to your environment as by adding to `/venv/bin/activate` the following line:
`export CENSUS='yourApiKey'`

0 comments on commit 0cd2a2e

Please sign in to comment.