Skip to content

UDST/urbansim_templates

Repository files navigation

Build Status Coverage Status

UrbanSim Templates

UrbanSim Templates is a Python library that provides building blocks for Orca-based simulation models. It's part of the Urban Data Science Toolkit (UDST).

The library contains templates for common types of model steps, plus a tool called ModelManager that runs as an extension to the Orca task orchestrator. ModelManager can register template-based model steps with the orchestrator, save them to disk, and automatically reload them for future sessions. The package was developed to make it easier to set up new simulation models — model step templates reduce the need for custom code and make settings more portable between models.

Installation

UrbanSim Templates can be installed using the Pip or Conda package managers.

pip install urbansim_templates
conda install urbansim_templates --channel conda-forge

Documentation

See the online documentation for much more: https://udst.github.io/urbansim_templates

Some additional documentation is available within the repo in CHANGELOG.md, CONTRIBUTING.md, /docs/README.md, and /tests/README.md.

There's discussion of current and planned features in the pull requests and issues, both open and closed.