quetzal-transport 3.1.1

modeling library for transport planning

quetzal

What is it?

quetzal is a Python package providing flexible models for transport planning and traffic forecasting.

Copyright

(c) SYSTRA

License

CeCILL-B

Documentation

The official documentation is hosted on https://systragroup.github.io/quetzal

Backward compatibility

In order to improve the ergonomics, the code may be re-factored and a few method calls may be re-designed. As a consequence, the backward compatibility of the library is not guaranteed. Therefore, the version of quetzal used for a project should be specified in its requirements.

Installation

pip install quetzal-transport

Installation from sources

For Linux

One should choose between

• Poetry (recommended)
• Virtualenv
• Anaconda

poetry

1. May need to set the default (or local) python version in the project

pyenv local 3.12

2. install dependancies (this will create a new virtualenv)

poetry install

3. activate the env

poetry shell

4. add the env to ipykernel (to use in jupyter)

python -m ipykernel install --user --name=quetzal_env

Virtualenv

Virtual environment: virtualenv .venv -p python3.12; source .venv/bin/activate or any equivalent command.

pip install -e .

Anaconda

In order to use python notebook, Anaconda 3 + Python 3.12 must be installed. Then create + activate quetzal environment:

conda init
conda create -n quetzal_env -y python=3.12
conda activate quetzal_env
pip install -e . -r requirements_win.txt
python -m ipykernel install --user --name=quetzal_env

For Windows

Anaconda 3 + Python 3.12 is supposed to be installed

PIP and Anaconda (recommended)

To create quetzal_env automatically and install quetzal, open anaconda prompt and run windows-install batch file

(base) C:users\you\path\to\quetzal> windows-install.bat

press enter to accept default environment name or enter a custom name

If you are facing SSL issues

(base) pip config set global.trusted-host "pypi.org files.pythonhosted.org"
(base) C:users\you\path\to\quetzal> windows-install.bat

security warning: the host is added to pip.ini

If you are facing DLL or dependencies issues

Anaconda and Pip do not get along well, your Anaconda install may have been corrupted at some point.

• Remove your envs
• Uninstall Anaconda
• Delete your Python and Anaconda folders (users\you\Anaconda3, users\you\Appdata\Roaming\Python, ...etc)
• Install Anaconda

Deploying

1. change the version in pyproject.toml

[tool.poetry]
name = "quetzal-transport"
version = "3.1.1"

2. create a tag matching the version (starting with v)

git tag -a v3.1.1 -m 'description'

3. push the tag

git push origin v3.1.1

that's it. A Github action will

• build
• create a release
• update the package on pipy.