api.rst

API

Domain datatypes

conflowgen.ContainerFlowAdjustedToVehicleType

conflowgen.ContainerLength

conflowgen.ContainerVolumeByVehicleType

conflowgen.ContainerVolumeFromOriginToDestination

conflowgen.HinterlandModalSplit

conflowgen.ModeOfTransport

conflowgen.OutboundUsedAndMaximumCapacity

conflowgen.RequiredAndMaximumCapacityComparison

conflowgen.StorageRequirement

conflowgen.TransshipmentAndHinterlandSplit

conflowgen.VehicleIdentifier

Setting up ConFlowGen

conflowgen.DatabaseChooser

conflowgen.setup_logger

Setting input data

With the following classes, the schedules, input values and input distributions are set. These are all required for generating the synthetic data.

conflowgen.ContainerFlowGenerationManager

conflowgen.ContainerLengthDistributionManager

conflowgen.StorageRequirementDistributionManager

conflowgen.ContainerWeightDistributionManager

conflowgen.ModeOfTransportDistributionManager

conflowgen.ContainerDwellTimeDistributionManager

conflowgen.PortCallManager

conflowgen.TruckArrivalDistributionManager

Generating previews

conflowgen.ContainerFlowByVehicleTypePreview

conflowgen.ContainerFlowByVehicleTypePreviewReport

conflowgen.InboundAndOutboundVehicleCapacityPreview

conflowgen.InboundAndOutboundVehicleCapacityPreviewReport

conflowgen.ModalSplitPreview

conflowgen.ModalSplitPreviewReport

conflowgen.run_all_previews

conflowgen.VehicleCapacityExceededPreview

conflowgen.VehicleCapacityUtilizationOnOutboundJourneyPreviewReport

Running analyses

conflowgen.ContainerDwellTimeAnalysis

conflowgen.ContainerDwellTimeAnalysisReport

conflowgen.ContainerFlowAdjustmentByVehicleTypeAnalysis

conflowgen.ContainerFlowAdjustmentByVehicleTypeAnalysisReport

conflowgen.ContainerFlowVehicleTypeAdjustmentPerVehicleAnalysis

conflowgen.ContainerFlowVehicleTypeAdjustmentPerVehicleAnalysisReport

conflowgen.ContainerFlowAdjustmentByVehicleTypeAnalysisSummary

conflowgen.ContainerFlowAdjustmentByVehicleTypeAnalysisSummaryReport

conflowgen.ContainerFlowByVehicleTypeAnalysis

conflowgen.ContainerFlowByVehicleTypeAnalysisReport

conflowgen.InboundAndOutboundVehicleCapacityAnalysis

conflowgen.InboundAndOutboundVehicleCapacityAnalysisReport

conflowgen.InboundToOutboundVehicleCapacityUtilizationAnalysis

conflowgen.InboundToOutboundVehicleCapacityUtilizationAnalysisReport

conflowgen.ModalSplitAnalysis

conflowgen.ModalSplitAnalysisReport

conflowgen.QuaySideThroughputAnalysis

conflowgen.QuaySideThroughputAnalysisReport

conflowgen.run_all_analyses

conflowgen.TruckGateThroughputAnalysis

conflowgen.TruckGateThroughputAnalysisReport

conflowgen.YardCapacityAnalysis

conflowgen.YardCapacityAnalysisReport

Using distributions

Most of the distributions in ConFlowGen are discrete distributions and are just reflected by classic Python dictionaries where the key refers to the element to be drawn and the value is the probability. In some cases, such as container dwell times, continuous distributions are required.

conflowgen.ContinuousDistribution

conflowgen.ContainerDwellTimeDistributionInterface

Working with reports

When working with .run_all_previews or .run_all_analyses, there is some common functionality. If you wish to add another markup language besides plaintext and markdown for these two lists of reports, you can define them here and pass them as parameters to the aforementioned functions.

conflowgen.DisplayAsMarkdown

conflowgen.DisplayAsMarkupLanguage

conflowgen.DisplayAsPlainText

Exporting data

conflowgen.ExportContainerFlowManager

conflowgen.ExportFileFormat