Skip to content

BayAreaMetro/tm2py

Repository files navigation

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 config --add channels conda-forge
conda create python=3.7 -n <my_conda_environment>
conda activate <my_conda_environment>

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 config --add channels conda-forge
conda create python=3.7  -n <my_conda_environment>
conda activate <my_conda_environment>
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 config --add channels conda-forge
conda create python=3.7 -n <my_conda_environment>
conda activate <my_lasso_environment>
git clone https://github.com/bayareametro/tm2py
cd tm2py
pip install -e .

Basic Usage

Contributing

Details can be found in [CONTRIBUTING]