ConFlowGen The Container Flow Generator - a Python application to generate container flows typical for seaport container terminals.

Please check in the background section of the documentation first whether ConFlowGen is the right tool for your purpose.

If you wish to use the module conflowgen, you can install the latest version using pip from the command line interface (CLI) of your choice (e.g., bash, PowerShell, or CMD).

pip install conflowgen

In addition, conflowgen is also available on conda-forge.

conda install -c conda-forge conflowgen

If you want to download all examples including simulation models, prepared SQLite databases, and Excel tables, it is best to obtain a full copy of this repository. Please ensure that git-lfs is installed and properly set up to download the larger files. Then, please execute the following lines in your CLI:

git clone https://github.com/1kastner/conflowgen 
cd conflowgen
pip install .

After you have installed the module, you are ready to define your own scenarios and generate the data.

import conflowgen
database_chooser = conflowgen.DatabaseChooser()
database_chooser.create_new_sqlite_database("new_example.sqlite")
...

The next steps are described in the documentation.

If you use ConFlowGen and decide to publish your results, we would be glad if you mention our work as defined at https://conflowgen.readthedocs.io/en/latest/background.html#presentation-of-conflowgen.