Home

UDOT Wrangler is a Python library for UDOT-related paramters and utilities with Network Wrangler.

System Requirements ¶

UDOT Wrangler does require Python 3.7+. (Note: Recommend Python version: 3.10) If you have a different version of Python installed (e.g. from ArcGIS), PIP or a similar virtual environment manager can care of installing it for you in the installation instructions below.

installing Python

UDOT Wrangler has been fully tested with 3.10. Using the latest version of Python 3.13 may have issues with any updated APIs or dependencies. If you would like to install Python 3.10. You can do so from the official Python release: https://www.python.org/downloads/. It should take care of installing pip for you.

installing conda?

For conda users, apologies that UDOT Wrangler has not yet been published to conda distribution channels. You will not be able to install via your common conda install ... command. But you could use pip install ....

Installation ¶

Step 1. Create and Activate Virtual Environment ¶

Create and/or activate the virtual environment where you want to install UDOT Wrangler.

Option 1. Create a new Python virtual environment using PIP

python -m venv udot_wrangler_env
udot_wrangler_env\Scripts\activate

Option 2. Create a new Python virtual environment using Conda

conda create -n udot_wrangler_env python=3.10
conda activate udot_wrangler_env

Option 3. Use Python package and project manager such as UV

If you care about speed and dependency lock, UV is a better option than pip.

uv init

Step 2. Install UDOT Wrangler and its Dependencies ¶

UDOT Wrangler is available on PyPI.

Latest Official Version ¶

Users can install via the standard pip command. In the activated Python environment created in Step 1, type:

pip install udot-wrangler

Users can also install via UV.

uv add udot-wrangler
# if `network-wrangler` is a prerelease
# uv add udot-wrangler --prerelease=allow

From GitHub ¶

pip install git+https://github.com/wsp-sag/udot_wrangler.git@main#egg=udot_wrangler

If you wanted to install from a specific tag/version number or branch, replace @main with @<branchname> or @tag

From Clone ¶

If you are going to be working on UDOT Wrangler 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.

If you have GitHub desktop installed, you can either do this by using the GitHub user interface by clicking on the green button “clone or download” in the main UDOT wrangler repository page.

Otherwise, you can use the command prompt to navigate to the directory that you would like to store your UDOT wrangler clone and then using a git command to clone it.

cd path to where you want to put wrangler
git clone https://github.com/wsp-sag/udot_wrangler

Then you should be able to install UDOT Wrangler in “develop” mode.

cd udot_wrangler
pip install -e .

Common Installation Issues ¶

TBD

Quickstart ¶

To get a feel for the API and using project cards, please refer to the prototype jupyter notebooks in .notebook.

To start the notebook, open a command line in the udot_wrangler top-level directory and type:

jupyter notebook

When launching jupyter notebook from conda, you may want to set the following:

conda install ipykernel
python -m ipykernel install --user --name=udot_wrangler_env --display-name "Python (udot_wrangler_env)"

Contributing ¶

Contributions are welcome. Please review contributing guidelines and instructions.

Companion Software ¶

The following software are key dependencies of UDOT Wrangler. They are installed as part of UDOT Wrangler installation so that you do not need to install them individually.

NetworkWrangler: Network Wrangler is a Python library for managing travel model network scenarios.

CubeWrangler: A Python package that contains utilities for working with Network Wrangler and CUBE. CUBE is a commercial travel modeling software package. CUBE Wrangler contains methods for carrying out the I/O to and from CUBE.

ProjectCard: Initially part of NetworkWrangler, the functionality for reading, writing and validating ProjectCard objects was pulled out into a separate project so that it could be used by other entities without necessitating NetworkWrangler.

Having an issue? ¶

🪲 UDOT Wrangler may contain bugs.

🤔 Also, since it has primarily been used by its developers, the documentation may contain some omissions or not be entirely clear.

But we’d love to make it better! Please report bugs or incorrect/unclear/missing documentation with a GitHub Issue - or fix them yourself with a pull request!

License ¶

Apache-2.0

Release History ¶

Changelog ¶

Notable changes and version history.

Version	Date	Comment
0.1.2	2025-07-20	Prototyped with Cache County network