Data processing, modelling, analysis and visualisation.

Python is required to run the scripts in this project. We suggest using miniconda to set up an environment and manage library dependencies.

Create a conda environment from the environment.yml definition:

conda env create -f environment.yml
conda install python-igraph

See http://igraph.org/python/ for instructions on Windows installation of python-igraph.

Activate the environment:

conda activate vietnam-transport

Set up the vtra package (this project) for development use:

python setup.py develop

The economic model uses GAMS (General Algebraic Modeling System) via its python API. GAMS provide installation and licensing instructions.

Much of the data processing requires access to a PostgreSQL database with the PostGIS extension installed and enabled.

The location of data and output files are configured by a config.json file. Copy config.template.json and edit the file paths and database connection details to locate the files on your system and access your database.

Make sure not to commit data inadvertently if working with jupyter notebooks. Suggest using nbstripout to automatically strip output.

Install git hooks to filter notebooks when committing to git:

cd /path/to/vietnam-transport
nbstripout --install

All code is copyright Oxford Infrastructure Analytics.