maritime_simulator

• mable package
  • Subpackages
    • mable.competition package
      • Submodules
      • mable.competition.generation module
      • mable.competition.information module
      • Module contents
    • mable.examples package
      • Submodules
      • mable.examples.companies module
      • mable.examples.environment module
      • mable.examples.fleets module
      • mable.examples.shipping module
      • Module contents
    • mable.extensions package
      • Submodules
      • mable.extensions.cargo_distributions module
      • mable.extensions.fuel_emissions module
      • mable.extensions.world_ports module
      • Module contents
    • mable.io package
      • Submodules
      • mable.io.logging_util module
      • Module contents
    • mable.simulation_space package
      • Submodules
      • mable.simulation_space.structure module
      • mable.simulation_space.universe module
      • Module contents
  • Submodules
  • mable.cargo_bidding module
    • MCSTCompany
      • MCSTCompany.inform()
    • MeansCompany
      • MeansCompany.inform()
    • TradingCompany
      • TradingCompany.__init__()
      • TradingCompany.fleet
      • TradingCompany.headquarters
      • TradingCompany.inform()
      • TradingCompany.receive()
  • mable.cli module
    • ArgumentParserExtensions
      • ArgumentParserExtensions.is_positive_integer()
      • ArgumentParserExtensions.is_valid_file()
    • handle_exception()
    • main()
    • select_task()
    • task_metrics_overview()
  • mable.engine module
    • EnginePrePostRunner
      • EnginePrePostRunner.run()
    • SimulationEngine
      • SimulationEngine.POST_RUN_CMDS
      • SimulationEngine.PRE_RUN_CMDS
      • SimulationEngine.__init__()
      • SimulationEngine.add_new_schedules()
      • SimulationEngine.apply_new_schedules()
      • SimulationEngine.class_factory
      • SimulationEngine.event_queue
      • SimulationEngine.find_company_for_vessel()
      • SimulationEngine.get_event_observers()
      • SimulationEngine.global_agent_timeout
      • SimulationEngine.headquarters
      • SimulationEngine.info
      • SimulationEngine.market
      • SimulationEngine.market_authority
      • SimulationEngine.notify_event_observer()
      • SimulationEngine.output_directory
      • SimulationEngine.register_event_observer()
      • SimulationEngine.run()
      • SimulationEngine.shipping
      • SimulationEngine.shipping_companies
      • SimulationEngine.unregister_event_observer()
      • SimulationEngine.world
    • pre_run_inform_vessel_locations()
    • pre_run_place_vessels()
  • mable.event_management module
    • ArrivalEvent
      • ArrivalEvent.distance()
      • ArrivalEvent.event_action()
    • CargoAnnouncementEvent
      • CargoAnnouncementEvent.__init__()
      • CargoAnnouncementEvent.event_action()
    • CargoEvent
      • CargoEvent.__init__()
      • CargoEvent.event_action()
    • CargoTransferEvent
      • CargoTransferEvent.distance()
      • CargoTransferEvent.event_action()
    • DurationEvent
      • DurationEvent.__init__()
      • DurationEvent.added_to_queue()
      • DurationEvent.has_started()
      • DurationEvent.performed_time()
      • DurationEvent.time_started
    • Event
      • Event.__init__()
      • Event.added_to_queue()
      • Event.event_action()
      • Event.time
    • EventExecutionData
      • EventExecutionData.__init__()
      • EventExecutionData.action_data
      • EventExecutionData.other_data
    • EventItem
      • EventItem.__init__()
      • EventItem.event
      • EventItem.time
    • EventObserver
      • EventObserver.notify()
    • EventQueue
      • EventQueue.__init__()
      • EventQueue.get()
      • EventQueue.purge()
      • EventQueue.put()
      • EventQueue.remove()
    • FirstCargoAnnouncementEvent
      • FirstCargoAnnouncementEvent.__init__()
      • FirstCargoAnnouncementEvent.event_action()
    • IdleEvent
      • IdleEvent.__init__()
      • IdleEvent.distance()
      • IdleEvent.location
    • TravelEvent
      • TravelEvent.__init__()
      • TravelEvent.added_to_queue()
      • TravelEvent.distance()
      • TravelEvent.event_action()
      • TravelEvent.is_laden
      • TravelEvent.location
    • VesselCargoEvent
      • VesselCargoEvent.__init__()
      • VesselCargoEvent.distance()
      • VesselCargoEvent.is_drop_off
      • VesselCargoEvent.is_pickup
      • VesselCargoEvent.location
      • VesselCargoEvent.trade
    • VesselEvent
      • VesselEvent.__init__()
      • VesselEvent.distance()
      • VesselEvent.event_action()
      • VesselEvent.location
      • VesselEvent.vessel
    • VesselLocationInformationEvent
      • VesselLocationInformationEvent.__init__()
      • VesselLocationInformationEvent.distance()
      • VesselLocationInformationEvent.location
  • mable.global_setup module
    • done()
  • mable.instructions module
    • Specifications
      • Specifications.Builder
      • Specifications.__init__()
      • Specifications.get()
      • Specifications.init_from_json_string()
  • mable.metrics module
    • GlobalMetricsCollector
      • GlobalMetricsCollector.add_co2_emissions()
      • GlobalMetricsCollector.add_cost()
      • GlobalMetricsCollector.add_fuel_consumption()
      • GlobalMetricsCollector.add_route_point()
    • MetricDict
    • MetricsCollector
      • MetricsCollector.__init__()
      • MetricsCollector.add_company_numeric_metric()
      • MetricsCollector.add_dual_numeric_metric()
      • MetricsCollector.add_global_company_list_metric()
      • MetricsCollector.get_company_id()
      • MetricsCollector.get_vessel_id()
      • MetricsCollector.to_json()
    • RegionalMetricsCollector
      • RegionalMetricsCollector.add_fuel_consumption()
    • VesselKey
      • VesselKey.__init__()
      • VesselKey.company_id
      • VesselKey.key_tuple
      • VesselKey.vessel_id
  • mable.observers module
    • AuctionMetricsObserver
      • AuctionMetricsObserver.notify()
    • AuctionOutcomeObserver
      • AuctionOutcomeObserver.notify()
    • AuctionOutcomePrintObserver
      • AuctionOutcomePrintObserver.__init__()
      • AuctionOutcomePrintObserver.notify()
    • EventFuelPrintObserver
      • EventFuelPrintObserver.__init__()
      • EventFuelPrintObserver.notify()
    • LogRunner
      • LogRunner.__init__()
      • LogRunner.run()
    • MetricsObserver
      • MetricsObserver.__init__()
      • MetricsObserver.calculate_consumption()
      • MetricsObserver.metrics
      • MetricsObserver.notify()
    • TradeDeliveryObserver
      • TradeDeliveryObserver.notify()
  • mable.shipping_market module
    • AuctionAllocationResult
      • AuctionAllocationResult.__init__()
      • AuctionAllocationResult.ledger
      • AuctionAllocationResult.unallocated_trades
    • AuctionLedger
      • AuctionLedger.__init__()
      • AuctionLedger.get_trades_for_company_copy()
      • AuctionLedger.keys
      • AuctionLedger.ledger
      • AuctionLedger.sanitised_ledger
    • AuctionMarket
      • AuctionMarket.__init__()
      • AuctionMarket.distribute_trades()
      • AuctionMarket.inform_future_trades()
    • Contract
      • Contract.__init__()
      • Contract.copy()
      • Contract.fulfilled
      • Contract.payment
      • Contract.to_json()
      • Contract.trade
    • Market
      • Market.__init__()
      • Market.distribute_trades()
    • Shipping
      • Shipping.__init__()
      • Shipping.add_to_all_trades()
      • Shipping.get_trades()
      • Shipping.get_trading_times()
      • Shipping.initialise_trades()
    • SimpleMarket
      • SimpleMarket.__init__()
      • SimpleMarket.distribute_trades()
    • StaticShipping
      • StaticShipping.initialise_trades()
    • TimeWindowTrade
      • TimeWindowTrade.__init__()
      • TimeWindowTrade.clean_window()
      • TimeWindowTrade.earliest_drop_off
      • TimeWindowTrade.earliest_drop_off_clean
      • TimeWindowTrade.earliest_pickup
      • TimeWindowTrade.earliest_pickup_clean
      • TimeWindowTrade.latest_drop_off
      • TimeWindowTrade.latest_drop_off_clean
      • TimeWindowTrade.latest_pickup
      • TimeWindowTrade.latest_pickup_clean
      • TimeWindowTrade.time_window
    • Trade
      • Trade.__init__()
      • Trade.amount
      • Trade.cargo_type
      • Trade.destination_port
      • Trade.origin_port
      • Trade.probability
      • Trade.status
      • Trade.time
      • Trade.to_json()
    • TradeStatus
      • TradeStatus.ACCEPTED
      • TradeStatus.NOT_REALISED
      • TradeStatus.REJECTED
      • TradeStatus.UNKNOWN
  • mable.simulation_de_serialisation module
    • DataClass
      • DataClass.__init__()
      • DataClass.current_class
    • DataProtocol
      • DataProtocol.Data
      • DataProtocol.__init__()
    • DataSchema
      • DataSchema.opts
    • DynamicNestedField
    • SchemaProtocol
      • SchemaProtocol.Schema
      • SchemaProtocol.__init__()
    • SimulationSpecification
      • SimulationSpecification.get()
      • SimulationSpecification.register()
      • SimulationSpecification.register_by_type_name()
  • mable.simulation_environment module
    • SimulationEngineAware
      • SimulationEngineAware.__init__()
      • SimulationEngineAware.set_engine()
    • World
      • World.__init__()
      • World.current_time
      • World.do_events_exists()
      • World.event_queue
      • World.get_next_event()
      • World.network
      • World.random
      • World.set_engine()
  • mable.simulation_generation module
    • ClassFactory
      • ClassFactory.generate_cargo_capacity()
      • ClassFactory.generate_company()
      • ClassFactory.generate_engine()
      • ClassFactory.generate_event_arrival()
      • ClassFactory.generate_event_cargo()
      • ClassFactory.generate_event_cargo_transfer()
      • ClassFactory.generate_event_idling()
      • ClassFactory.generate_event_location_info()
      • ClassFactory.generate_event_queue()
      • ClassFactory.generate_event_travel()
      • ClassFactory.generate_location()
      • ClassFactory.generate_market()
      • ClassFactory.generate_network()
      • ClassFactory.generate_port()
      • ClassFactory.generate_random()
      • ClassFactory.generate_shipping()
      • ClassFactory.generate_trade()
      • ClassFactory.generate_vessel()
      • ClassFactory.generate_world()
    • SimulationBuilder
      • SimulationBuilder.__init__()
      • SimulationBuilder.generate_engine()
      • SimulationBuilder.generate_fleet()
      • SimulationBuilder.generate_market()
      • SimulationBuilder.generate_network()
      • SimulationBuilder.generate_random()
      • SimulationBuilder.generate_shipping()
      • SimulationBuilder.generate_shipping_companies()
      • SimulationBuilder.generate_vessel()
      • SimulationBuilder.generate_world()
      • SimulationBuilder.set_engines()
  • mable.transport_operation module
    • Bid
      • Bid.__init__()
      • Bid.amount
      • Bid.company
      • Bid.trade
    • CargoCapacity
      • CargoCapacity.Data
      • CargoCapacity.__init__()
      • CargoCapacity.capacity
      • CargoCapacity.cargo_type
      • CargoCapacity.loading_rate
      • CargoCapacity.to_json()
    • CargoContainer
      • CargoContainer.__init__()
      • CargoContainer.amount
      • CargoContainer.capacity
      • CargoContainer.loading_rate
    • CargoHold
      • CargoHold.__init__()
      • CargoHold.available_cargo_types()
      • CargoHold.get_capacity()
      • CargoHold.get_current_load()
      • CargoHold.get_loading_rate()
      • CargoHold.is_empty()
      • CargoHold.load_cargo()
      • CargoHold.unload_cargo()
    • CargoHoldSchema
      • CargoHoldSchema.opts
    • ScheduleProposal
      • ScheduleProposal.__init__()
      • ScheduleProposal.costs
      • ScheduleProposal.scheduled_trades
      • ScheduleProposal.schedules
    • ShippingCompany
      • ShippingCompany.Data
      • ShippingCompany.__init__()
      • ShippingCompany.fleet
      • ShippingCompany.get_class()
      • ShippingCompany.inform()
      • ShippingCompany.name
      • ShippingCompany.pre_inform()
      • ShippingCompany.receive()
      • ShippingCompany.set_engine()
    • SimpleCompany
      • SimpleCompany.__init__()
      • SimpleCompany.apply_schedules()
      • SimpleCompany.get_arrival_time()
      • SimpleCompany.inform()
      • SimpleCompany.pre_inform()
      • SimpleCompany.propose_schedules()
      • SimpleCompany.receive()
    • SimpleVessel
      • SimpleVessel.Data
      • SimpleVessel.__init__()
      • SimpleVessel.get_loading_time()
      • SimpleVessel.get_travel_time()
      • SimpleVessel.speed
      • SimpleVessel.to_json()
    • Vessel
      • Vessel.Data
      • Vessel.__init__()
      • Vessel.capacities_and_loading_rates
      • Vessel.capacity()
      • Vessel.copy_hold()
      • Vessel.current_load()
      • Vessel.event_occurrence()
      • Vessel.get_loading_time()
      • Vessel.get_travel_time()
      • Vessel.has_any_load()
      • Vessel.has_next_event()
      • Vessel.journey_log
      • Vessel.load_cargo()
      • Vessel.loadable_cargo_types()
      • Vessel.location
      • Vessel.log_journey_log_event()
      • Vessel.name
      • Vessel.schedule
      • Vessel.set_engine()
      • Vessel.start_next_event()
      • Vessel.unload_cargo()
  • mable.transportation_scheduling module
    • CurrentState
      • CurrentState.__init__()
      • CurrentState.current_cargo_hold
      • CurrentState.current_location
      • CurrentState.current_time
      • CurrentState.engine
      • CurrentState.is_valid
      • CurrentState.vessel
    • Schedule
      • Schedule.__init__()
      • Schedule.add_relocation()
      • Schedule.add_transportation()
      • Schedule.completion_time()
      • Schedule.copy()
      • Schedule.get()
      • Schedule.get_insertion_points()
      • Schedule.get_scheduled_trades()
      • Schedule.get_simple_schedule()
      • Schedule.init_with_engine()
      • Schedule.next()
      • Schedule.pop()
      • Schedule.verify_schedule()
      • Schedule.verify_schedule_cargo()
      • Schedule.verify_schedule_time()
    • TransportationSourceDestinationIndicator
      • TransportationSourceDestinationIndicator.DROP_OFF
      • TransportationSourceDestinationIndicator.PICK_UP
    • TransportationStartFinishIndicator
      • TransportationStartFinishIndicator.FINISH
      • TransportationStartFinishIndicator.START
  • mable.util module
    • JsonAble
      • JsonAble.__init__()
      • JsonAble.to_json()
    • JsonAbleEncoder
      • JsonAbleEncoder.default()
    • format_time()
  • Module contents