pytraf 0.3.1__tar.gz

pytraf-0.3.1/Cargo.lock

@@ -0,0 +1,368 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 4
+
+[[package]]
+name = "autocfg"
+version = "1.5.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f2032f911046de80f0a198e0901378627c33f59ea0ac00e363d481118bd70a53"
+
+[[package]]
+name = "crossbeam-deque"
+version = "0.8.8"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "622f3fc73690be383c7214310406f28a90e6edeadc3cea882f9d71e495b9711a"
+dependencies = [
+ "crossbeam-epoch",
+ "crossbeam-utils",
+]
+
+[[package]]
+name = "crossbeam-epoch"
+version = "0.9.21"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "dc74980687109a3b14c72fd458107bf0baa1da1a1a805e178d15501ba9b86d9d"
+dependencies = [
+ "crossbeam-utils",
+]
+
+[[package]]
+name = "crossbeam-utils"
+version = "0.8.23"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a31eee39dddec8330830986fcd7625edb5a24ec90ea038215273bbc3adb08ac6"
+
+[[package]]
+name = "csv"
+version = "1.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "52cd9d68cf7efc6ddfaaee42e7288d3a99d613d4b50f76ce9827ae0c6e14f938"
+dependencies = [
+ "csv-core",
+ "itoa",
+ "ryu",
+ "serde_core",
+]
+
+[[package]]
+name = "csv-core"
+version = "0.1.13"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "704a3c26996a80471189265814dbc2c257598b96b8a7feae2d31ace646bb9782"
+dependencies = [
+ "memchr",
+]
+
+[[package]]
+name = "either"
+version = "1.19.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0e9c71c2167ca323c882b99918929403426e2373ea17242ff5653e0d5e1058be"
+
+[[package]]
+name = "heck"
+version = "0.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
+
+[[package]]
+name = "itoa"
+version = "1.0.18"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8f42a60cbdf9a97f5d2305f08a87dc4e09308d1276d28c869c684d7777685682"
+
+[[package]]
+name = "libc"
+version = "0.2.190"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ce5d3ddc6d3fa000eb1536d85e147bfe31aacaba692ed6a876f95cb7c855be78"
+
+[[package]]
+name = "matrixmultiply"
+version = "0.3.11"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3f607c237553f086e7043417a51df26b2eb899d3caff94e6a67592ff992fedc7"
+dependencies = [
+ "autocfg",
+ "rawpointer",
+]
+
+[[package]]
+name = "memchr"
+version = "2.8.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "cf8baf1c55e62ffcace7a9f06f4bd9cd3f0c4beb022d3b367256b91b87513d98"
+
+[[package]]
+name = "ndarray"
+version = "0.17.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "520080814a7a6b4a6e9070823bb24b4531daac8c4627e08ba5de8c5ef2f2752d"
+dependencies = [
+ "matrixmultiply",
+ "num-complex",
+ "num-integer",
+ "num-traits",
+ "portable-atomic",
+ "portable-atomic-util",
+ "rawpointer",
+]
+
+[[package]]
+name = "num-complex"
+version = "0.4.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "73f88a1307638156682bada9d7604135552957b7818057dcef22705b4d509495"
+dependencies = [
+ "num-traits",
+]
+
+[[package]]
+name = "num-integer"
+version = "0.1.47"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7ce2d95d4b3734dc35aa2f45e1aa22cd416814592a4f9d9205e11affd5b8e10b"
+dependencies = [
+ "num-traits",
+]
+
+[[package]]
+name = "num-traits"
+version = "0.2.19"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "071dfc062690e90b734c0b2273ce72ad0ffa95f0c74596bc250dcfd960262841"
+dependencies = [
+ "autocfg",
+]
+
+[[package]]
+name = "numpy"
+version = "0.29.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6a5b15d63a5ff39e378daed0e1340d3a5964703ea9712eb09a0dc66fade996f4"
+dependencies = [
+ "libc",
+ "ndarray",
+ "num-complex",
+ "num-integer",
+ "num-traits",
+ "pyo3",
+ "pyo3-build-config",
+ "rustc-hash",
+]
+
+[[package]]
+name = "once_cell"
+version = "1.21.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50"
+
+[[package]]
+name = "portable-atomic"
+version = "1.15.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "05c8b63e8d9609db387f0324918f81d68fe27748f084ef092fb35954d0539a85"
+
+[[package]]
+name = "portable-atomic-util"
+version = "0.2.8"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "10ab3eb7f3becc3a1cbc4f2c6f20267996cfc1a6467a873763411b136a122715"
+dependencies = [
+ "portable-atomic",
+]
+
+[[package]]
+name = "proc-macro2"
+version = "1.0.107"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "985e7ec9bb745e6ce6535b544d84d6cd6f7ad8bd711c398938ae983b91a766d9"
+dependencies = [
+ "unicode-ident",
+]
+
+[[package]]
+name = "pyo3"
+version = "0.29.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "700d18fa267b73b9b521fd7e13580e2f446916f176cacee1ab63fcc8191f1655"
+dependencies = [
+ "libc",
+ "once_cell",
+ "portable-atomic",
+ "pyo3-build-config",
+ "pyo3-ffi",
+ "pyo3-macros",
+]
+
+[[package]]
+name = "pyo3-build-config"
+version = "0.29.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7b3fc0c4d08f6bb10e71fe39dfb9e2f59c6eb6854e22ec8092f50c69a4499adb"
+dependencies = [
+ "target-lexicon",
+]
+
+[[package]]
+name = "pyo3-ffi"
+version = "0.29.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "dfc0b8e19df29aad7086cf977bb0c2a2f143e30567eb113e9cf72b62ca698330"
+dependencies = [
+ "libc",
+ "pyo3-build-config",
+]
+
+[[package]]
+name = "pyo3-macros"
+version = "0.29.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6100e8a4b5eba53afaa5ed078364851a0b2499c553a44c31026b929049b49dc6"
+dependencies = [
+ "proc-macro2",
+ "pyo3-macros-backend",
+ "quote",
+ "syn 2.0.119",
+]
+
+[[package]]
+name = "pyo3-macros-backend"
+version = "0.29.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6143877a16e82b5a727b7127ff4cd86858a24a28d745d72f43e6f227c7b1bdb3"
+dependencies = [
+ "heck",
+ "proc-macro2",
+ "quote",
+ "syn 2.0.119",
+]
+
+[[package]]
+name = "pytraf-core"
+version = "0.3.1"
+dependencies = [
+ "rayon",
+]
+
+[[package]]
+name = "pytraf-io"
+version = "0.3.1"
+dependencies = [
+ "csv",
+ "pytraf-core",
+ "rayon",
+]
+
+[[package]]
+name = "pytraf-py"
+version = "0.3.1"
+dependencies = [
+ "numpy",
+ "pyo3",
+ "pytraf-core",
+ "pytraf-io",
+ "rayon",
+]
+
+[[package]]
+name = "quote"
+version = "1.0.47"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1fbf4db142a473a8d80c26bbf18454ed458bf8d26c8219c331daecfdbd079001"
+dependencies = [
+ "proc-macro2",
+]
+
+[[package]]
+name = "rawpointer"
+version = "0.2.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "60a357793950651c4ed0f3f52338f53b2f809f32d83a07f72909fa13e4c6c1e3"
+
+[[package]]
+name = "rayon"
+version = "1.12.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "fb39b166781f92d482534ef4b4b1b2568f42613b53e5b6c160e24cfbfa30926d"
+dependencies = [
+ "either",
+ "rayon-core",
+]
+
+[[package]]
+name = "rayon-core"
+version = "1.13.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "22e18b0f0062d30d4230b2e85ff77fdfe4326feb054b9783a3460d8435c8ab91"
+dependencies = [
+ "crossbeam-deque",
+ "crossbeam-utils",
+]
+
+[[package]]
+name = "rustc-hash"
+version = "2.1.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6b1e7f9a428571be2dc5bc0505c13fb6bf936822b894ec87abf8a08a4e51742d"
+
+[[package]]
+name = "ryu"
+version = "1.0.23"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9774ba4a74de5f7b1c1451ed6cd5285a32eddb5cccb8cc655a4e50009e06477f"
+
+[[package]]
+name = "serde_core"
+version = "1.0.229"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "67dca2c9c51e58a4791a4b1ed58308b39c64224d349a935ab5039aa360942a48"
+dependencies = [
+ "serde_derive",
+]
+
+[[package]]
+name = "serde_derive"
+version = "1.0.229"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e7a5d71263a5a7d47b41f6b3f06ba276f10cc18b0931f1799f710578e2309348"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn 3.0.9",
+]
+
+[[package]]
+name = "syn"
+version = "2.0.119"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "872831b642d1a07999a962a351ed35b955ea2cfc8f3862091e2a240a84f17297"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "syn"
+version = "3.0.9"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d78c8dee4c7bf0e14673097256fed6142ce9d3b85a408189d07482442145823b"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "target-lexicon"
+version = "0.13.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "adb6935a6f5c20170eeceb1a3835a49e12e19d792f6dd344ccc76a985ca5a6ca"
+
+[[package]]
+name = "unicode-ident"
+version = "1.0.27"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a2c754d6c33795a1c324727428e5a7dedb5b06195f9890bdbcba760d3e246563"

pytraf-0.3.1/Cargo.toml

@@ -0,0 +1,9 @@
+[workspace]
+members = ["crates/core", "crates/io", "crates/python"]
+resolver = "2"
+
+[workspace.package]
+version = "0.3.1"
+edition = "2024"
+license = "MIT"
+repository = "https://github.com/harisbal/pytraf"

pytraf-0.3.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Haris Ballis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pytraf-0.3.1/PKG-INFO

@@ -0,0 +1,239 @@
+Metadata-Version: 2.4
+Name: pytraf
+Version: 0.3.1
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Rust
+Classifier: Topic :: Scientific/Engineering
+Requires-Dist: numpy>=1.23
+Requires-Dist: mkdocs>=1.6,<2 ; extra == 'docs'
+Requires-Dist: mkdocs-material>=9.7,<10 ; extra == 'docs'
+Requires-Dist: mkdocstrings[python]>=0.26 ; extra == 'docs'
+Requires-Dist: ruff ; extra == 'docs'
+Requires-Dist: pandas>=1.5 ; extra == 'pandas'
+Requires-Dist: pytest>=7 ; extra == 'test'
+Requires-Dist: pandas>=1.5 ; extra == 'test'
+Provides-Extra: docs
+Provides-Extra: pandas
+Provides-Extra: test
+License-File: LICENSE
+Summary: Path-based traffic assignment with turn delays and multiple vehicle classes.
+Keywords: traffic assignment,user equilibrium,transportation,gradient projection,GMNS
+Author: Haris Ballis
+License: MIT
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Changelog, https://harisbal.github.io/pytraf/changelog/
+Project-URL: Documentation, https://harisbal.github.io/pytraf/
+Project-URL: Issues, https://github.com/harisbal/pytraf/issues
+Project-URL: Repository, https://github.com/harisbal/pytraf
+
+# PyTraf
+
+[![Release](https://img.shields.io/github/v/release/harisbal/pytraf)](https://github.com/harisbal/pytraf/releases)
+[![Docs](https://img.shields.io/badge/docs-harisbal.github.io%2Fpytraf-blue)](https://harisbal.github.io/pytraf/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-green)](https://github.com/harisbal/pytraf/blob/main/LICENSE)
+
+Path-based traffic assignment with turn delays and multiple vehicle classes.
+
+**Documentation: <https://harisbal.github.io/pytraf/>**
+
+PyTraf is an open-source package for **static user-equilibrium traffic assignment** on road networks.
+Given a network and an origin–destination demand matrix, it computes the link and path flows that
+satisfy Wardrop's first principle, solving the problem in path space with gradient projection.
+
+Its main features are:
+
+- **Path-based equilibration** by gradient projection, with Frank-Wolfe as a reference method. Path
+  flows are retained, so select-link and route-level analyses need no post-processing.
+- **Turn-aware routing**: turn prohibitions, fixed turn penalties and flow-dependent turn delays, handled
+  exactly by labelling links rather than nodes in the shortest-path search.
+- **Multi-class assignment**, with class-specific demand, passenger-car equivalents, generalised link
+  costs (e.g. tolls) and link restrictions.
+- **Background traffic**: fixed preloads on links and turns, such as buses or through traffic.
+- **Tabular results**: link, turn and path results as pandas DataFrames, or as NumPy arrays.
+- **Standard input formats**: TNTP benchmark files, GMNS datasets, or plain tables (pandas DataFrames,
+  NumPy arrays).
+- **Validation** against published equilibrium solutions of the standard test networks.
+- **Performance**: a multi-threaded Rust core, usable from Python or directly from Rust.
+
+## Install
+
+```sh
+pip install pytraf
+pip install pandas        # optional: for the DataFrame inputs and tables
+```
+
+Wheels for Linux, macOS and Windows need Python 3.9 or newer and nothing else. To build from source you need
+Rust ([rustup](https://rustup.rs)) and [maturin](https://www.maturin.rs):
+
+```sh
+uv venv .venv && source .venv/bin/activate        # or python -m venv
+uv pip install numpy pandas pytest maturin
+maturin develop --release                          # builds and installs `pytraf`
+pytest                                             # optional: run the Python tests
+```
+
+## Python quick start
+
+```python
+import pytraf
+
+net = pytraf.Network.from_tntp("data/tntp/SiouxFalls/SiouxFalls_net.tntp")
+demand = pytraf.Demand.from_tntp(net, "data/tntp/SiouxFalls/SiouxFalls_trips.tntp")
+
+result = net.assign(demand, gap=1e-6)
+result.converged, result.iterations, result.relative_gap
+result.links.flow         # numpy array, one entry per link
+result.diagnostics.objective   # Beckmann objective (single class, PCE 1)
+result.links.table()      # DataFrame: flow, volume/capacity and time per link
+result.paths.table()      # DataFrame: every path with its flow, time and links
+print(result.summary())   # a short account of the run
+```
+
+From your own tables (DataFrames or dicts of arrays):
+
+```python
+net = pytraf.Network.from_tables(links_df, turns_df)           # see docs/guide/python.md for columns
+demand = pytraf.Demand.from_table(net, trips_df)
+result = net.assign(demand, gap=1e-6)
+```
+
+Several classes:
+
+```python
+cars   = pytraf.TrafficClass(car_demand)
+trucks = pytraf.TrafficClass(truck_demand, pce=2.5,
+                           extra_link_cost=toll_in_minutes,        # per link, same units as time
+                           allowed_links=~truck_banned)            # bool per link
+result = net.assign([cars, trucks], gap=1e-6)
+result.links.by_class["trucks"]   # vehicles of one class, by name or position
+result.links.volume              # PCE-weighted volume that drives travel times
+```
+
+A worked example is in [Getting started](https://harisbal.github.io/pytraf/getting-started/); every table column is in
+[the Python guide](https://harisbal.github.io/pytraf/guide/python/).
+
+## Rust quick start
+
+```rust
+use pytraf_core::*;
+use pytraf_io::tntp::{read_net, read_trips};
+
+let net = read_net("data/tntp/SiouxFalls/SiouxFalls_net.tntp")?;
+let trips = read_trips("data/tntp/SiouxFalls/SiouxFalls_trips.tntp")?;
+let demand = OdDemand::from_triples(
+    net.network.num_nodes(), &trips.origins, &trips.destinations, &trips.flows)?;
+let turns = TurnTable::build(&net.network, &net.is_endpoint, &[], TurnOptions::default())?;
+let vdf = Bpr::new(net.free_flow_time, net.capacity, net.b, net.power)?;
+
+let result = gradient_projection(&net.network, &turns, &vdf, &demand,
+                                 GradientProjectionOptions::default())?;
+println!("{} sweeps, gap {:.2e}", result.iterations, result.relative_gap);
+```
+
+`gradient_projection_multiclass` takes a slice of `ClassSpec`s and a turn delay function.
+The core crate does no file IO: it takes typed arrays, so Rust and Python users call the same code.
+
+## Does it get the right answer?
+
+It reproduces the published solutions of the standard benchmark networks (Sioux Falls, Anaheim) and is
+checked against independent models; see [docs/benchmarks.md](https://harisbal.github.io/pytraf/benchmarks/).
+
+## Layout
+
+```
+crates/core     algorithms, no IO: network, turns, shortest paths, solvers, path store
+crates/io       TNTP reader (and the benchmark example)
+crates/python   PyO3 bindings (the `pytraf._pytraf` extension)
+python/pytraf     Python package: DataFrame helpers and type stubs
+python/tests    pytest suite
+data/tntp       benchmark networks from github.com/bstabler/TransportationNetworks
+docs            the documentation site source (MkDocs): guides, concepts, design, benchmarks
+```
+
+## Documentation
+
+The full documentation is a MkDocs site built from `docs/`:
+
+```sh
+uv pip install -e ".[docs]"
+mkdocs serve                 # live preview at http://127.0.0.1:8000
+mkdocs build --strict        # static site in site/
+cargo doc --workspace --no-deps --open     # Rust API reference
+```
+
+## Limitations
+
+PyTraf solves the static problem: no queue spillback, and delays depend only on a link's or turn's own
+traffic. See [the roadmap](https://harisbal.github.io/pytraf/design/roadmap/).
+
+## Next steps
+
+Planned extensions, roughly in order:
+
+- **Larger networks**: lower path memory and faster flow updates, for models with several thousand zones.
+- **OpenStreetMap networks**, converted to GMNS or flat tables in the Python layer.
+- **Link-direction optimisation**, built on the assignment engine.
+- **Interacting junction models** for signalised and priority junctions.
+
+**Stochastic user equilibrium** is deliberately deferred: PyTraf keeps the deterministic equilibrium for
+now. When it is added, path-based logit SUE fits the existing solver best. The full list, with the
+current limitations, is in the [roadmap](https://harisbal.github.io/pytraf/design/roadmap/).
+
+## Contributing
+
+Bug reports, questions and pull requests are welcome on
+[GitHub](https://github.com/harisbal/pytraf/issues). For larger changes, please open an issue first to
+discuss the approach.
+
+- **Tests.** Check new solver features against something independent of the code: a published solution,
+  a closed-form equilibrium or an equivalent model.
+- **Design decisions** are recorded in [docs/design/decisions](https://github.com/harisbal/pytraf/tree/main/docs/design/decisions); add one for any change to the model or the API.
+- **Before opening a pull request**, run:
+
+```sh
+cargo fmt --check && cargo clippy --workspace --all-targets
+cargo test --workspace
+maturin develop --release && pytest
+mkdocs build --strict
+```
+
+Benchmarks: `cargo run --release -p pytraf-io --example order_benchmark -- Anaheim 1e-4 1e-6`.
+
+**Releases.** The version lives in one place, `[workspace.package]` in `Cargo.toml`; the crates, the
+Python package (`pytraf.__version__`) and the docs read it from there. To release, bump it, update
+`version` and `date-released` in `CITATION.cff` and the citation in this README, then tag `vX.Y.Z` and
+publish a GitHub release.
+
+## Citing PyTraf
+
+If you use PyTraf in your research, please cite it as below (GitHub's "Cite this repository" button gives
+the same from [`CITATION.cff`](https://github.com/harisbal/pytraf/blob/main/CITATION.cff)):
+
+> Ballis, H. (2026). *PyTraf: Path-based static traffic assignment* (Version 0.3.1)
+> [Computer software]. https://github.com/harisbal/pytraf
+
+```bibtex
+@software{ballis_pytraf_2026,
+  author  = {Ballis, Haris},
+  title   = {{PyTraf}: Path-based static traffic assignment},
+  year    = {2026},
+  version = {0.3.1},
+  url     = {https://github.com/harisbal/pytraf}
+}
+```
+
+## License
+
+MIT. The benchmark networks in `data/tntp` come from
+[TransportationNetworks](https://github.com/bstabler/TransportationNetworks) and keep their own terms.
+