`nrel.hive.resources.mock_lobster`

Module Contents

Classes

DefaultIds

Functions

`somewhere`(→ nrel.hive.util.typealiases.GeoId)
`somewhere_else`(→ nrel.hive.util.typealiases.GeoId)
`mock_geojson`(→ Dict)
`mock_membership`()
`mock_geofence`(, resolution)
`mock_network`(...)
`mock_osm_route`(→ nrel.hive.model.roadnetwork.route.Route)	A mock route taken from the mock osm network
`mock_osm_network`(...)
`mock_base`(, lat, lon, h3_res, station_id, stall_count, ...)
`mock_base_from_geoid`(, geoid, station_id, stall_count, ...)
`mock_station`(, lat, lon, h3_res[, chargers, ...])
`mock_station_from_geoid`(, geoid[, chargers, ...])
`mock_rate_structure`(...)
`mock_request`(, o_lat, o_lon, d_lat, d_lon, h3_res, ...)
`mock_request_from_geoids`(, origin, destination, ...)
`mock_ev_powertrain`(...)
`mock_powercurve`(...)
`mock_bev`(→ nrel.hive.model.vehicle.mechatronics.bev.BEV)
`mock_ice_powertrain`(...)
`mock_ice`(→ nrel.hive.model.vehicle.mechatronics.ice.ICE)
`mock_vehicle`(, lat, lon, h3_res, mechatronics, ...)
`mock_vehicle_from_geoid`(, geoid, mechatronics, ...)
`mock_human_driver`([available, schedule_id, ...])
`mock_runner_payload`(...)
`mock_sim`(, stations, Ellipsis] =, bases, Ellipsis] =, ...)
`mock_config`(→ nrel.hive.config.HiveConfig)
`mock_env`(, mechatronics, ...)
`mock_reporter`(→ nrel.hive.reporting.reporter.Reporter)
`mock_route_from_geoids`(...)
`mock_graph_links`(→ Dict[str, ...)	test_routetraversal is dependent on this graph topology + its attributes
`mock_route`(...)
`mock_forecaster`(...)
`mock_instruction_generators`(...)
`mock_update`(...)
`mock_l1_charger_id`()
`mock_l2_charger_id`()
`mock_dcfc_charger_id`()
`mock_l1_charger`()
`mock_l2_charger`()
`mock_dcfc_charger`()
`mock_gasoline_pump`()

class nrel.hive.resources.mock_lobster.DefaultIds[source]

classmethod mock_request_id() → nrel.hive.util.typealiases.RequestId[source]

classmethod mock_vehicle_id() → nrel.hive.util.typealiases.VehicleId[source]

classmethod mock_station_id() → nrel.hive.util.typealiases.StationId[source]

classmethod mock_base_id() → nrel.hive.util.typealiases.BaseId[source]

classmethod mock_mechatronics_bev_id() → nrel.hive.util.typealiases.MechatronicsId[source]

classmethod mock_mechatronics_ice_id() → nrel.hive.util.typealiases.MechatronicsId[source]

classmethod mock_schedule_id() → nrel.hive.util.typealiases.ScheduleId[source]

classmethod mock_membership_id() → nrel.hive.util.typealiases.MembershipId[source]

nrel.hive.resources.mock_lobster.somewhere() → nrel.hive.util.typealiases.GeoId[source]

nrel.hive.resources.mock_lobster.somewhere_else() → nrel.hive.util.typealiases.GeoId[source]

nrel.hive.resources.mock_lobster.mock_geojson() → Dict[source]

nrel.hive.resources.mock_lobster.mock_membership()[source]

nrel.hive.resources.mock_lobster.mock_geofence(geojson: Dict = mock_geojson(), resolution: nrel.hive.util.typealiases.H3Resolution = 10) → nrel.hive.model.roadnetwork.geofence.GeoFence[source]

nrel.hive.resources.mock_lobster.mock_network(h3_res: nrel.hive.util.typealiases.H3Resolution = 15, geofence_res: nrel.hive.util.typealiases.H3Resolution = 10) → nrel.hive.model.roadnetwork.roadnetwork.RoadNetwork[source]

nrel.hive.resources.mock_lobster.mock_osm_route() → nrel.hive.model.roadnetwork.route.Route[source]: A mock route taken from the mock osm network

nrel.hive.resources.mock_lobster.mock_osm_network(h3_res: nrel.hive.util.typealiases.H3Resolution = 15, geofence_res: nrel.hive.util.typealiases.H3Resolution = 10) → nrel.hive.model.roadnetwork.osm.osm_roadnetwork.OSMRoadNetwork[source]

nrel.hive.resources.mock_lobster.mock_base(base_id: nrel.hive.util.typealiases.BaseId = DefaultIds.mock_base_id(), lat: float = 39.7539, lon: float = -104.974, h3_res: int = 15, station_id: nrel.hive.util.typealiases.StationId | None = None, stall_count: int = 1, road_network: nrel.hive.model.roadnetwork.roadnetwork.RoadNetwork = mock_network(), membership: nrel.hive.model.membership.Membership = Membership()) → nrel.hive.model.base.Base[source]

nrel.hive.resources.mock_lobster.mock_base_from_geoid(base_id: nrel.hive.util.typealiases.BaseId = DefaultIds.mock_base_id(), geoid: nrel.hive.util.typealiases.GeoId = h3.geo_to_h3(39.7539, -104.974, 15), station_id: nrel.hive.util.typealiases.StationId | None = None, stall_count: int = 1, membership: nrel.hive.model.membership.Membership = Membership(), road_network: nrel.hive.model.roadnetwork.roadnetwork.RoadNetwork = mock_network()) → nrel.hive.model.base.Base[source]

nrel.hive.resources.mock_lobster.mock_station(station_id: nrel.hive.util.typealiases.StationId = DefaultIds.mock_station_id(), lat: float = 39.7539, lon: float = -104.974, h3_res: int = 15, chargers=None, on_shift_access_chargers=None, road_network: nrel.hive.model.roadnetwork.roadnetwork.RoadNetwork = mock_network(), membership: nrel.hive.model.membership.Membership = Membership()) → nrel.hive.model.station.station.Station[source]

nrel.hive.resources.mock_lobster.mock_station_from_geoid(station_id: nrel.hive.util.typealiases.StationId = DefaultIds.mock_station_id(), geoid: nrel.hive.util.typealiases.GeoId = h3.geo_to_h3(39.7539, -104.974, 15), chargers=None, on_shift_access_chargers=None, road_network: nrel.hive.model.roadnetwork.roadnetwork.RoadNetwork = mock_network(), membership: nrel.hive.model.membership.Membership = Membership(), env: nrel.hive.runner.environment.Environment | None = None) → nrel.hive.model.station.station.Station[source]

nrel.hive.resources.mock_lobster.mock_rate_structure(base_price: nrel.hive.util.units.Currency = 2.2, price_per_mile: nrel.hive.util.units.Currency = 1.6, minimum_price: nrel.hive.util.units.Currency = 5) → nrel.hive.model.request.RequestRateStructure[source]

nrel.hive.resources.mock_lobster.mock_request(request_id: nrel.hive.util.typealiases.RequestId = DefaultIds.mock_request_id(), o_lat: float = 39.7539, o_lon: float = -104.974, d_lat: float = 39.7579, d_lon: float = -104.978, h3_res: int = 15, road_network: nrel.hive.model.roadnetwork.roadnetwork.RoadNetwork = mock_network(), departure_time: nrel.hive.model.sim_time.SimTime = SimTime(0), passengers: int = 1, fleet_id: nrel.hive.util.typealiases.MembershipId | None = None, allows_pooling: bool = False) → nrel.hive.model.request.Request[source]

nrel.hive.resources.mock_lobster.mock_request_from_geoids(request_id: nrel.hive.util.typealiases.RequestId = DefaultIds.mock_request_id(), origin: nrel.hive.util.typealiases.GeoId = h3.geo_to_h3(39.7539, -104.974, 15), destination: nrel.hive.util.typealiases.GeoId = h3.geo_to_h3(39.7579, -104.978, 15), road_network: nrel.hive.model.roadnetwork.roadnetwork.RoadNetwork = mock_network(), departure_time: nrel.hive.model.sim_time.SimTime = SimTime(0), passengers: int = 1, value: nrel.hive.util.units.Currency = 0, fleet_id: nrel.hive.util.typealiases.MembershipId | None = None, allows_pooling: bool = False) → nrel.hive.model.request.Request[source]

nrel.hive.resources.mock_lobster.mock_ev_powertrain(nominal_watt_hour_per_mile) → nrel.hive.model.vehicle.mechatronics.powertrain.tabular_powertrain.TabularPowertrain[source]

nrel.hive.resources.mock_lobster.mock_powercurve(nominal_max_charge_kw=50, battery_capacity_kwh=50) → nrel.hive.model.vehicle.mechatronics.powercurve.tabular_powercurve.TabularPowercurve[source]

nrel.hive.resources.mock_lobster.mock_bev(battery_capacity_kwh=50, idle_kwh_per_hour=0.8, nominal_watt_hour_per_mile=225, nominal_max_charge_kw=50, charge_taper_cutoff_kw=10) → nrel.hive.model.vehicle.mechatronics.bev.BEV[source]

nrel.hive.resources.mock_lobster.mock_ice_powertrain(nominal_miles_per_gallon) → nrel.hive.model.vehicle.mechatronics.powertrain.tabular_powertrain.TabularPowertrain[source]

nrel.hive.resources.mock_lobster.mock_ice(tank_capacity_gallons=15, idle_gallons_per_hour=0.2, nominal_miles_per_gallon=30) → nrel.hive.model.vehicle.mechatronics.ice.ICE[source]

nrel.hive.resources.mock_lobster.mock_vehicle(vehicle_id: nrel.hive.util.typealiases.VehicleId = DefaultIds.mock_vehicle_id(), lat: float = 39.7539, lon: float = -104.974, h3_res: int = 15, mechatronics: nrel.hive.model.vehicle.mechatronics.mechatronics_interface.MechatronicsInterface = mock_bev(), vehicle_state: nrel.hive.state.vehicle_state.vehicle_state.VehicleState | None = None, soc: nrel.hive.util.units.Ratio = 1, driver_state: nrel.hive.state.driver_state.driver_state.DriverState | None = None, membership: nrel.hive.model.membership.Membership = Membership(), total_seats: int = 999) → nrel.hive.model.vehicle.vehicle.Vehicle[source]

nrel.hive.resources.mock_lobster.mock_vehicle_from_geoid(vehicle_id: nrel.hive.util.typealiases.VehicleId = DefaultIds.mock_vehicle_id(), geoid: nrel.hive.util.typealiases.GeoId = h3.geo_to_h3(39.7539, -104.974, 15), mechatronics: nrel.hive.model.vehicle.mechatronics.mechatronics_interface.MechatronicsInterface = mock_bev(), vehicle_state: nrel.hive.state.vehicle_state.vehicle_state.VehicleState | None = None, soc: nrel.hive.util.units.Ratio = 1, driver_state: nrel.hive.state.driver_state.driver_state.DriverState | None = None, membership: nrel.hive.model.membership.Membership = Membership(), total_seats: int = 999) → nrel.hive.model.vehicle.vehicle.Vehicle[source]

nrel.hive.resources.mock_lobster.mock_human_driver(available: bool = True, schedule_id: nrel.hive.util.typealiases.ScheduleId = DefaultIds.mock_schedule_id(), home_base_id: nrel.hive.util.typealiases.BaseId = DefaultIds.mock_base_id(), allows_pooling: bool = True)[source]

nrel.hive.resources.mock_lobster.mock_runner_payload() → nrel.hive.runner.runner_payload.RunnerPayload[source]

nrel.hive.resources.mock_lobster.mock_sim(sim_time: int = 0, sim_timestep_duration_seconds: nrel.hive.util.units.Seconds = 60, h3_location_res: int = 15, h3_search_res: int = 10, vehicles: Tuple[nrel.hive.model.vehicle.vehicle.Vehicle, Ellipsis] = (), stations: Tuple[nrel.hive.model.station.station.Station, Ellipsis] = (), bases: Tuple[nrel.hive.model.base.Base, Ellipsis] = (), road_network: nrel.hive.model.roadnetwork.roadnetwork.RoadNetwork = mock_network()) → nrel.hive.state.simulation_state.simulation_state.SimulationState[source]

nrel.hive.resources.mock_lobster.mock_config(start_time: str | int = 0, end_time: str | int = 100, timestep_duration_seconds: nrel.hive.util.units.Seconds = 1, sim_h3_location_resolution: int = 15, sim_h3_search_resolution: int = 9, input_config: Dict | None = None) → nrel.hive.config.HiveConfig[source]

nrel.hive.resources.mock_lobster.mock_env(config: nrel.hive.config.HiveConfig = mock_config(), mechatronics: Dict[nrel.hive.util.typealiases.MechatronicsId, nrel.hive.model.vehicle.mechatronics.mechatronics_interface.MechatronicsInterface] | None = None, chargers: Dict[nrel.hive.util.typealiases.ChargerId, nrel.hive.model.energy.charger.Charger] | None = None, schedules: Dict[nrel.hive.util.typealiases.ScheduleId, Callable[[nrel.hive.state.simulation_state.simulation_state.SimulationState, nrel.hive.util.typealiases.VehicleId], bool]] | None = None, fleet_ids: FrozenSet[nrel.hive.util.typealiases.MembershipId] = frozenset([DefaultIds.mock_membership_id()])) → nrel.hive.runner.environment.Environment[source]

nrel.hive.resources.mock_lobster.mock_reporter() → nrel.hive.reporting.reporter.Reporter[source]

nrel.hive.resources.mock_lobster.mock_route_from_geoids(src: nrel.hive.util.typealiases.GeoId, dst: nrel.hive.util.typealiases.GeoId, speed_kmph: nrel.hive.util.units.Kmph = 1) → Tuple[nrel.hive.model.roadnetwork.link.Link, Ellipsis][source]

nrel.hive.resources.mock_lobster.mock_graph_links(h3_res: int = 15, speed_kmph: nrel.hive.util.units.Kmph = 1) → Dict[str, nrel.hive.model.roadnetwork.link.Link][source]: test_routetraversal is dependent on this graph topology + its attributes each link is approximately 1 kilometer

nrel.hive.resources.mock_lobster.mock_route(h3_res: int = 15, speed_kmph: nrel.hive.util.units.Kmph = 1) → Tuple[nrel.hive.model.roadnetwork.link.Link, Ellipsis][source]