transportations-library 0.1.12

CrossTraffic transportations library

Transportations Library

A comprehensive Rust-based library implementing transportation engineering methodologies (e.g., the Highway Capacity Manual (HCM)) with Python bindings.

Features

• Highway Capacity Manual (HCM) 7th Edition methodology implementations:

  • Chapter 11: Freeway Reliability Analysis
  • Chapter 12: Basic Freeway Segments
  • Chapter 13: Freeway Weaving Segments
  • Chapter 14: Freeway Merge and Diverge Segments
  • Chapter 15: Two-Lane Highways (including Bicycle LOS)
  • Managed Lanes

• Python bindings via PyO3/Maturin for easy integration

Installation

Rust

[dependencies]
transportations_library = "0.1"

Python

pip install transportations-library

Usage

Rust

use transportations_library::hcm::weaving::{WeavingInput, analyze};

let input = WeavingInput::default();
let result = analyze(&input);
println!("LOS: {:?}", result.los);

Python

import transportations_library as tl

# Use HCM methodologies
# (Python bindings documentation coming soon)

Documentation

This project uses two documentation systems:

API Reference (rustdoc)

Auto-generated from code comments:

cargo doc --open

Published at: https://docs.rs/transportations-library

User Guide (mdbook)

Conceptual guides, tutorials, and examples located in docs/book/:

cd docs/book
mdbook serve    # Serve locally at http://localhost:3000
mdbook build    # Build to docs/book/book/

Using mdbook-toc

The documentation uses mdbook-toc to generate inline tables of contents.

Install:

cargo install mdbook mdbook-toc

Usage in markdown files:

Add <!-- toc --> marker where you want the table of contents:

# Page Title

<!-- toc -->

## Section 1
Content...

## Section 2
Content...

The marker will be replaced with clickable links to each section.

Configuration (in docs/book/book.toml):

[preprocessor.toc]
command = "mdbook-toc"
renderer = ["html"]
max-level = 4

License

Licensed under either of:

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.