1kastner / conflowgen

A generator for synthetic container flows at maritime container terminals with a focus on yard operations
MIT License
11 stars 7 forks source link

Add a get method to the PortCallManager informing the user about the planned seaside throughput for a given time window #188

Closed 1kastner closed 1 year ago

1kastner commented 1 year ago

Is your feature request related to a problem? Please describe. For some formula that we use in static layout planning, we need the annual seaside throughput, typically in TEU per annum. Currently, this is somehow part of the preview, see e.g. https://conflowgen.readthedocs.io/en/latest/notebooks/previews.html#Instantiating-a-Preview-Report, but it is not straight-forward.

Describe the solution you'd like At https://github.com/1kastner/conflowgen/blob/main/conflowgen/api/port_call_manager.py, I can add vessels and I can check wether a vessel is in the database. However, I would like to know how many TEU or boxes are already planned to be discharged at the terminal.

Describe alternatives you've considered Just stick to the existing previews.

1kastner commented 1 year ago

This actually resembles https://github.com/1kastner/conflowgen/issues/7. To keep the concept of previews clear, it is better to handle within a preview and not in the main API.