s2mflow: Multicommodity Flow Instance Generator
===============================================

.. s2mflow documentation master file.

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

.. toctree::
   :maxdepth: 2
   :caption: Contents:

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.

API Reference
-------------
This section is automatically generated from the source code docstrings.

.. automodule:: s2mflow
   :members:
   :undoc-members:
   :show-inheritance:
   :inherited-members:

Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`