API Reference

Contents:

• Introduction
  • The stoplist
    • The CPE Stop
  • The Simulation run: advancing the internal clock
  • The dispatcher
  • The Transport Space
• FleetState
  • The FleetState interface
    • FleetState
      • FleetState.from_fleet()
      • FleetState.simulate()
      • FleetState.fast_forward()
      • FleetState.handle_transportation_request()
      • FleetState.handle_internal_request()
      • FleetState._apply_request_solution()
  • Different implementations of the FleetState interface
    • SlowSimpleFleetState
• VehicleState
  • VehicleState
    • VehicleState.stoplist
    • VehicleState.fast_forward_time()
    • VehicleState.handle_transportation_request_single_vehicle()
• Data Structures
  • Requests
    • Request
    • TransportationRequest
    • InternalRequest
  • LocType
    • LocType
  • Stop and Stoplist
    • StopAction
    • Stop
  • The TransportSpace and Dispatcher interfaces
    • TransportSpace
      • TransportSpace.d()
      • TransportSpace.t()
      • TransportSpace.random_point()
      • TransportSpace.interp_time()
      • TransportSpace.interp_dist()
    • SingleVehicleSolution
    • Dispatcher
• Events
  • Event
  • RequestSubmissionEvent
  • RequestAcceptanceEvent
  • RequestRejectionEvent
  • PickupEvent
  • DeliveryEvent
  • InternalEvent
  • VehicleStateBeginEvent
  • VehicleStateEndEvent
  • RequestEvent
  • StopEvent
  • RequestResponse
• Package util
  • The dispatchers
  • The spaces
    • Euclidean
    • Manhattan2D
    • Graph
      • Graph._make_attribute_distance()
      • Graph.from_nx()
      • Graph.interp_dist()
      • Graph.interp_time()
  • The request generators
    • RandomRequestGenerator
  • The analytics package
    • get_stops_and_requests()
    • get_stops_and_requests_from_events_dataframe()
    • get_vehicle_quantities()
    • get_system_quantities()
• Cythonic reference
  • Overview of the cythonic components
  • Cython wrapping internals
    • Handling different types of location objects
      • The Explicit Runtime Dispatch approach
    • Instantiating Extension dtypes from existing C++ objects
  • Cythonic VehicleState
    • VehicleState
      • VehicleState.fast_forward_time()
  • Cython Data Structures
    • ridepy.data_structures_cython.LocType
    • TransportationRequest
      • TransportationRequest.__reduce__()
      • TransportationRequest.asdict()
    • InternalRequest
      • InternalRequest.__reduce__()
      • InternalRequest.asdict()
    • Stop
      • Stop.__deepcopy__()
      • Stop.__reduce__()
      • Stop.asdict()
    • Stoplist
      • Stoplist.__reduce__()
      • Stoplist.remove_nth_elem()
      • Stoplist.to_pys()
  • Cython Spaces
    • Euclidean2D
      • Euclidean2D.__reduce__()
      • Euclidean2D.asdict()
      • Euclidean2D.random_point()
    • Manhattan2D
      • Manhattan2D.__reduce__()
      • Manhattan2D.asdict()
      • Manhattan2D.random_point()
    • Graph
      • Graph.__reduce__()
      • Graph.asdict()
      • Graph.from_nx()
      • Graph.random_point()
    • TransportSpace
      • TransportSpace.asdict()
      • TransportSpace.interp_dist()
      • TransportSpace.interp_time()
  • Cython dispatchers
• Module extras
  • Simulations and Parameter Scans
    • Parameter Configuration
    • Executing simulations
      • SimulationSet
        • SimulationSet.run()
        • SimulationSet.simulation_ids
        • SimulationSet.param_paths
        • SimulationSet.event_paths
      • perform_single_simulation()
    • Running analytics on the simulation results
      • SimulationSet.run_analytics()
  • JSON IO
    • ParamsJSONEncoder
    • ParamsJSONDecoder
    • EventsJSONEncoder
    • sort_params()
    • create_params_json()
    • save_params_json()
    • read_params_json()
    • save_events_json()
    • read_events_json()
    • create_info_json()
  • Spaces
    • make_nx_grid()
    • make_nx_cycle_graph()
    • make_nx_star_graph()