nrel.hive.config.sim

Module Contents

Classes

Sim

Typed version of namedtuple.
class nrel.hive.config.sim.Sim[source]

Bases: NamedTuple

Typed version of namedtuple.

Usage in Python versions >= 3.6:

class Employee(NamedTuple):
    name: str
    id: int

This is equivalent to:

Employee = collections.namedtuple('Employee', ['name', 'id'])

The resulting class has an extra __annotations__ attribute, giving a dict that maps field names to types. (The field names are also in the _fields attribute, which is part of the namedtuple API.) Alternative equivalent keyword syntax is also accepted:

Employee = NamedTuple('Employee', name=str, id=int)

In Python versions <= 3.5 use:

Employee = NamedTuple('Employee', [('name', str), ('id', int)])
sim_name: str
timestep_duration_seconds: nrel.hive.util.units.Seconds
start_time: nrel.hive.model.sim_time.SimTime
end_time: nrel.hive.model.sim_time.SimTime
sim_h3_resolution: int
sim_h3_search_resolution: int
request_cancel_time_seconds: int
schedule_type: nrel.hive.model.vehicle.schedules.schedule_type.ScheduleType
min_delta_energy_change: nrel.hive.util.Ratio = 0.0001
seed: int | None = 0
classmethod default_config() → Dict[source]
classmethod required_config() → Tuple[str, Ellipsis][source]
classmethod build(config: Dict | None = None) → Sim[source]
classmethod from_dict(d: Dict) → Sim[source]
asdict() → Dict[source]