s2mflow: Multicommodity Flow Instance Generator

Welcome to the official documentation for s2mflow. This library provides a high-performance tool for generating multicommodity flow instances from single-commodity flow instances.

Introduction

s2mflow bridges the gap between theoretical multicommodity flow research and practical optimization by providing a robust generator implemented in Rust with a seamless Python interface via PyO3.

Installation

s2mflow can be installed across different environments depending on whether you are using the pre-compiled package or building from source.

Standard Python Installation

You can install s2mflow directly via pip (or poetry):

pip install s2mflow
# Or using Poetry
poetry add s2mflow

Building from Source

If you want to build s2mflow from source, ensure you have the Rust toolchain installed, then run:

git clone https://github.com/FelixBroesamle/s2mflow.git
cd s2mflow
poetry install -vvv
poetry run maturin develop --release

Running Mathematical Models

To run the mathematical modeling examples, install the optional solver dependencies:

poetry install --extras solver

User Guide:

• End-to-End Optimization Workflows
  • 1. Data Generation & Serialization Pipeline
  • 2. File-Based Parsing with Pyomo & HiGHS (Open-Source)
  • 3. In-Memory Generation with Gurobi (Commercial Solver)
• The .mcfmin Data Format
  • File Structure Overview
  • 1. The Problem Line
  • 2. The Node Line
  • 3. The Arc Line

Developer Guide:

• API Reference
• Classes
  • Edge
  • NetworkInstance
  • MultiCommoditySupplies
  • MultiCommodityData
  • ParsedMulticommodityInstance
• Functions
  • load_min_instance()
  • split_supplies_uniform()
  • split_supplies_spread()
  • generate_multi_commodity_data()
  • save_multi_commodity_instance()
  • load_multi_commodity_instance()
  • get_adjacency_mapping()

Indices and tables

• Index

• Module Index

• Search Page