Transport Flow Model

This Python package implements iterative capacity-constrained network flow allocation. It routes flows through networks sequentially until link capacities are exhausted, providing a simplified tool for infrastructure risk and resilience analysis.

It is part of the open-source National Infrastructure Systems Model (NISMOD) ecosystem developed by the Oxford Programme for Sustainable Infrastructure Systems (OPSIS) at the University of Oxford.

To run the model:

pip install -e .
python scripts/flow_model/flow_allocation.py ./config.example.json
python scripts/flow_model/flow_disruptions.py ./config.example.json

Development

We recommend the use of pixi to manage a development environment.

To run the tests (see [tool.pixi.tasks] within pyproject.toml):

pixi run test

Useful Pixi commands:

To add a new package dependency, make sure to use --pypi to include it in the pyproject.toml dependencies table:

pixi add --pypi geopandas

To add a new development dependency, make sure to use --pypi and --feature dev to include it in the pyproject.toml [dependency-groups] dev table:

pixi add --pypi --feature dev pytest

Acknowledgments

This research received funding from the UK FCDO Climate Compatible Growth Programme. The views expressed here do not necessarily reflect the UK government's official policies.