conflowgen

A generator for synthetic container flows at maritime container terminals with a focus on yard operations

https://github.com/1kastner/conflowgen

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 1 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (10.2%) to scientific vocabulary

Keywords

container-terminal logistics maritime sea-container synthetic-data
Last synced: 6 months ago · JSON representation ·

Repository

A generator for synthetic container flows at maritime container terminals with a focus on yard operations

Basic Info
  • Host: GitHub
  • Owner: 1kastner
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 2.5 MB
Statistics
  • Stars: 15
  • Watchers: 2
  • Forks: 7
  • Open Issues: 33
  • Releases: 10
Topics
container-terminal logistics maritime sea-container synthetic-data
Created about 4 years ago · Last pushed 6 months ago
Metadata Files
Readme Contributing License Citation

Readme.md

Documentation Status documentation built CITATION.cff valid

Tests codecov Linting CodeFactor

Demo Windows conda installation (conda in PATH) Windows conda installation (conda not in PATH)

pypi conda-forge GitHub DOI Install from repository

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).

bash pip install conflowgen

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

bash conda install 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:

bash 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.

python 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/latest/background.html#presentation-of-conflowgen.

Star History

Star History Chart

Owner

  • Login: 1kastner
  • Kind: user
  • Location: Hamburg
  • Company: TUHH

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: ConFlowGen
abstract: A generator for synthetic container flows at maritime container terminals with a focus on yard operations
contact:
  - affiliation: "Institute of Maritime Logistics, Hamburg University of Technology (TUHH)"
    email: marvin.kastner@tuhh.de
    family-names: Kastner
    given-names: Marvin
message: >-
  Please cite this software using the metadata from
  'preferred-citation'.
type: software
authors:
  - given-names: Marvin
    family-names: Kastner
    email: marvin.kastner@tuhh.de
    affiliation: Hamburg University of Technology (TUHH), Institute of Maritime Logistics
    orcid: 'https://orcid.org/0000-0001-8289-2943'
  - given-names: Ole
    family-names: Grasse
    email: ole.grasse@tuhh.de
    affiliation: Hamburg University of Technology (TUHH), Institute of Maritime Logistics
    orcid: 'https://orcid.org/0000-0003-1982-9436'
  - given-names: Shubhangi
    family-names: Gupta
    email: shubhangi.gupta@tuhh.de
    affiliation: Hamburg University of Technology (TUHH), Institute of Maritime Logistics
    orcid: 'https://orcid.org/0009-0003-3574-2899'
version: 3.0.1
repository-code: "https://github.com/1kastner/conflowgen"
keywords:
  - logistics
  - "synthetic data"
  - maritime
  - "sea container"
  - "container terminal"
license: MIT
identifiers:
  - description: This is the collection of archived snapshots of all versions of ConFlowGen
    type: doi
    value: 10.5281/zenodo.5849322
preferred-citation:
  title: Container Flow Generation for Maritime Container Terminals
  type: conference-paper
  doi: 10.1007/978-3-031-05359-7_11
  languages:
  - en
  publisher:
    name: Springer
    city: Cham
    country: CH
  conference:
      name: "LDIC 2022"
      city: Bremen
      country: DE
      date-start: 2022-02-23
      date-end: 2022-02-25
  editors:
    - family-names: Freitag
      given-names: Michael
    - family-names: Kinra
      given-names: Aseem
    - family-names: Kotzab
      given-names: Herbert
    - family-names: Megow
      given-names: Nicole
  collection-doi: 10.1007/978-3-031-05359-7
  collection-title: "Dynamics in Logistics. Proceedings of the 8th International Conference LDIC 2022, Bremen, Germany"
  collection-type: "proceedings"
  year: 2022
  isbn: 978-3-031-05359-7
  start: 133
  end: 143
  authors:
    - given-names: Marvin
      family-names: Kastner
      email: marvin.kastner@tuhh.de
      affiliation: Hamburg University of Technology (TUHH), Institute of Maritime Logistics
      orcid: 'https://orcid.org/0000-0001-8289-2943'
    - given-names: Ole
      family-names: Grasse
      email: ole.grasse@tuhh.de
      affiliation: Hamburg University of Technology (TUHH), Institute of Maritime Logistics
      orcid: 'https://orcid.org/0000-0003-1982-9436'
    - given-names: Carlos
      family-names: Jahn
      email: carlos.jahn@tuhh.de
      affiliation: Hamburg University of Technology (TUHH), Institute of Maritime Logistics
      orcid: 'https://orcid.org/0000-0002-5409-0748'

GitHub Events

Total
  • Create event: 11
  • Release event: 1
  • Issues event: 5
  • Watch event: 5
  • Delete event: 5
  • Issue comment event: 10
  • Push event: 44
  • Pull request review event: 5
  • Pull request review comment event: 2
  • Pull request event: 30
  • Fork event: 1
Last Year
  • Create event: 11
  • Release event: 1
  • Issues event: 5
  • Watch event: 5
  • Delete event: 5
  • Issue comment event: 10
  • Push event: 44
  • Pull request review event: 5
  • Pull request review comment event: 2
  • Pull request event: 30
  • Fork event: 1

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 320
  • Total Committers: 5
  • Avg Commits per committer: 64.0
  • Development Distribution Score (DDS): 0.031
Past Year
  • Commits: 57
  • Committers: 1
  • Avg Commits per committer: 57.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
1kastner m****r@t****e 310
ram24prasath 8****h@u****m 4
bbargstaedt b****t@g****m 2
1grasse 9****e@u****m 2
Ole Grasse o****e@t****e 2
Committer Domains (Top 20 + Academic)
tuhh.de: 2

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 55
  • Total pull requests: 120
  • Average time to close issues: 10 months
  • Average time to close pull requests: 7 days
  • Total issue authors: 3
  • Total pull request authors: 5
  • Average comments per issue: 0.8
  • Average comments per pull request: 1.03
  • Merged pull requests: 106
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 3
  • Pull requests: 27
  • Average time to close issues: N/A
  • Average time to close pull requests: 2 days
  • Issue authors: 2
  • Pull request authors: 3
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.44
  • Merged pull requests: 19
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • 1kastner (53)
  • sharmas1ddharth (1)
Pull Request Authors
  • 1kastner (97)
  • HarshithaPrabhuswamy (15)
  • lucedes27 (8)
  • shubhs-93 (5)
  • ram24prasath (3)
Top Labels
Issue Labels
enhancement (24) technical-debt (17) good first issue (15) documentation (6) low-priority (5) bug (2) discussion (1) wontfix (1)
Pull Request Labels

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 219 last-month
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 1
    (may contain duplicates)
  • Total versions: 12
  • Total maintainers: 2
pypi.org: conflowgen

A generator for synthetic container flows at maritime container terminals with a focus on yard operations

  • Versions: 10
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 219 Last month
Rankings
Dependent packages count: 9.6%
Forks count: 13.3%
Stargazers count: 17.1%
Average: 18.4%
Dependent repos count: 21.9%
Downloads: 29.9%
Maintainers (2)
Last synced: 6 months ago
conda-forge.org: conflowgen

A generator for synthetic container flows at maritime container terminals with a focus is on yard operations

  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 34.0%
Average: 48.1%
Dependent packages count: 51.2%
Forks count: 51.6%
Stargazers count: 55.7%
Last synced: 6 months ago