Travel Model 2 Python Package

Installation

If you are managing multiple python versions, we suggest using virtualenv or conda virtual environments.

The following instructions create and activate a conda environment (recommended) in which you can install:

conda env create -f environment.yml
conda activate tm2py

Basic installation instructions are as follows:

pip install tm2py

Bleeding Edge

If you want to install a more up-to-date or development version, you can do so by installing it from the develop branch as follows:

conda env create -f environment.yml
conda activate tm2py
pip install git+https://github.com/bayareametro/tm2py@develop

Developers (from clone)

If you are going to be working on Lasso locally, you might want to clone it to your local machine and install it from the clone. The -e will install it in editable mode.

conda env create -f environment.yml
conda activate tm2py
git clone https://github.com/bayareametro/tm2py
cd tm2py
pip install -e .

Note that you'll also need to install Emme's python packages into this conda environment. Following these instructions from an INRO community forum post: In the Emme Desktop application, open Tools->Application Options->Modeller, change your Python path as desired and click the "Install Modeller Package" button.

If this is successful, the following packages will be visible in your environment when you type pip list:

• inro-dynameq
• inro-emme
• inro-emme-agent
• inro-emme-engine
• inro-modeller

Note that doing the emme package install will also install the package pywin32; if pywin32 gets installed by other means (like conda or pip), then I got DLL load errors when tryring to import the emme packages, so I recommend uninstalling pywin32 before installing the emme packages.

Basic Usage

Copy and unzip example_union_test_highway.zip to a local drive and from within that directory run:

get_test_data <location>
tm2py -s scenario.toml -m model.toml

Contributing

Details can be found in [CONTRIBUTING]