laurel package

Subpackages

• laurel.datasets package
  • Submodules
  • laurel.datasets.directory_partitioned module
    • DirectoryPartitionedDataset
      • DirectoryPartitionedDataset.__init__()
      • DirectoryPartitionedDataset.load()
      • DirectoryPartitionedDataset.save()
  • laurel.datasets.geodatabase module
    • GeoDataBaseDataset
      • GeoDataBaseDataset.DEFAULT_LOAD_ARGS
      • GeoDataBaseDataset.DEFAULT_SAVE_ARGS
      • GeoDataBaseDataset.__init__()
      • GeoDataBaseDataset.load()
      • GeoDataBaseDataset.save()
  • laurel.datasets.geopackage module
    • GeoPackageDataset
      • GeoPackageDataset.DEFAULT_LOAD_ARGS
      • GeoPackageDataset.DEFAULT_SAVE_ARGS
      • GeoPackageDataset.__init__()
      • GeoPackageDataset.load()
      • GeoPackageDataset.save()
  • laurel.datasets.geoparquet module
    • GeoParquetDataset
      • GeoParquetDataset.DEFAULT_LOAD_ARGS
      • GeoParquetDataset.DEFAULT_SAVE_ARGS
      • GeoParquetDataset.__init__()
      • GeoParquetDataset.fs_args
      • GeoParquetDataset.load()
      • GeoParquetDataset.save()
  • laurel.datasets.shapefile module
    • ShapefileDataset
      • ShapefileDataset.DEFAULT_LOAD_ARGS
      • ShapefileDataset.DEFAULT_SAVE_ARGS
      • ShapefileDataset.__init__()
      • ShapefileDataset.load()
      • ShapefileDataset.save()
  • Module contents
• laurel.models package
  • Submodules
  • laurel.models.charging_algorithms module
    • Pipeline overview
    • Concrete strategies
    • Key design decisions
  • laurel.models.dwell_sets module
    • Key design decisions
  • laurel.models.group_times module
    • Concrete groupers
    • Key design decisions
  • laurel.models.manage_charging module
    • Key design decisions
  • laurel.models.probability_localization module
    • Algorithm (4 steps)
    • Key design decisions
  • laurel.models.sampling module
    • Supporting sparse-matrix utilities
    • Key design decisions
  • laurel.models.summarize module
    • Key design decisions
  • Module contents
• laurel.pipelines package
  • Subpackages
    • laurel.pipelines.build_scenarios package
      • Submodules
      • laurel.pipelines.build_scenarios.nodes module
      • laurel.pipelines.build_scenarios.pipeline module
      • Module contents
    • laurel.pipelines.compute_routes package
      • Submodules
      • laurel.pipelines.compute_routes.nodes module
      • laurel.pipelines.compute_routes.pipeline module
      • Module contents
    • laurel.pipelines.describe_dwells package
      • Submodules
      • laurel.pipelines.describe_dwells.nodes module
      • laurel.pipelines.describe_dwells.pipeline module
      • Module contents
    • laurel.pipelines.describe_locations package
      • Submodules
      • laurel.pipelines.describe_locations.nodes module
      • laurel.pipelines.describe_locations.pipeline module
      • Module contents
    • laurel.pipelines.describe_vehicles package
      • Submodules
      • laurel.pipelines.describe_vehicles.nodes module
      • laurel.pipelines.describe_vehicles.pipeline module
      • Module contents
    • laurel.pipelines.electrify_trips package
      • Submodules
      • laurel.pipelines.electrify_trips.nodes module
      • laurel.pipelines.electrify_trips.pipeline module
      • Module contents
    • laurel.pipelines.evaluate_impacts package
      • Submodules
      • laurel.pipelines.evaluate_impacts.nodes module
      • laurel.pipelines.evaluate_impacts.pipeline module
      • Module contents
    • laurel.pipelines.prepare_totals package
      • Submodules
      • laurel.pipelines.prepare_totals.nodes module
      • laurel.pipelines.prepare_totals.pipeline module
      • Module contents
  • Module contents
• laurel.routing package
  • Submodules
  • laurel.routing.client module
    • AsyncClient
      • AsyncClient.__init__()
      • AsyncClient.req
    • TrackedSemaphore
      • TrackedSemaphore.__init__()
      • TrackedSemaphore.acquire()
      • TrackedSemaphore.current_tasks
      • TrackedSemaphore.release()
  • laurel.routing.containers module
    • AbstractContainerRunner
      • AbstractContainerRunner.__init__()
      • AbstractContainerRunner.build_command()
      • AbstractContainerRunner.check_is_running()
      • AbstractContainerRunner.is_running()
      • AbstractContainerRunner.start()
      • AbstractContainerRunner.stop_existing()
    • ApptainerContainerRunner
      • ApptainerContainerRunner.build_command()
      • ApptainerContainerRunner.is_running()
      • ApptainerContainerRunner.stop_existing()
    • DockerContainerRunner
      • DockerContainerRunner.build_command()
      • DockerContainerRunner.is_running()
      • DockerContainerRunner.stop_existing()
  • laurel.routing.nodes module
    • start_routing_server_node()
    • stop_routing_server_node()
  • laurel.routing.parser module
    • AsyncGraphhopper
      • AsyncGraphhopper.__init__()
      • AsyncGraphhopper.directions()
      • AsyncGraphhopper.parse_directions_json()
  • laurel.routing.router module
    • get_routes()
  • laurel.routing.server module
    • GraphhopperContainerRouter
      • GraphhopperContainerRouter.__init__()
      • GraphhopperContainerRouter.import_graph()
      • GraphhopperContainerRouter.target_graph_dir
      • GraphhopperContainerRouter.target_port
  • Module contents
• laurel.scenario_builders package
  • Submodules
  • laurel.scenario_builders.batt_dual_pow module
    • BatteryDualPowerScenarioBuilder
      • BatteryDualPowerScenarioBuilder.partition_level_names
    • BatteryDualPowerScenarioReader
      • BatteryDualPowerScenarioReader.builder
      • BatteryDualPowerScenarioReader.extract_metadata()
      • BatteryDualPowerScenarioReader.metadata_level_names
      • BatteryDualPowerScenarioReader.name_scenario()
  • laurel.scenario_builders.batt_man module
    • BatteryManageScenarioBuilder
      • BatteryManageScenarioBuilder.partition_level_names
    • BatteryManageScenarioReader
      • BatteryManageScenarioReader.builder
      • BatteryManageScenarioReader.extract_metadata()
      • BatteryManageScenarioReader.metadata_level_names
      • BatteryManageScenarioReader.name_scenario()
  • laurel.scenario_builders.batt_pow module
    • BatteryPowerScenarioBuilder
      • BatteryPowerScenarioBuilder.partition_level_names
    • BatteryPowerScenarioReader
      • BatteryPowerScenarioReader.builder
      • BatteryPowerScenarioReader.extract_metadata()
      • BatteryPowerScenarioReader.metadata_level_names
      • BatteryPowerScenarioReader.name_scenario()
  • laurel.scenario_builders.ca_eight module
    • CalifClass8ScenarioBuilder
      • CalifClass8ScenarioBuilder.partition_level_names
    • CalifClass8ScenarioReader
      • CalifClass8ScenarioReader.builder
      • CalifClass8ScenarioReader.extract_metadata()
      • CalifClass8ScenarioReader.metadata_level_names
      • CalifClass8ScenarioReader.name_scenario()
    • multiply_dict_leaves()
  • laurel.scenario_builders.ca_eight_adopt module
    • CalifClass8AdoptionScenarioBuilder
      • CalifClass8AdoptionScenarioBuilder.partition_level_names
    • CalifClass8AdoptionScenarioReader
      • CalifClass8AdoptionScenarioReader.builder
      • CalifClass8AdoptionScenarioReader.extract_metadata()
      • CalifClass8AdoptionScenarioReader.metadata_level_names
      • CalifClass8AdoptionScenarioReader.name_scenario()
    • multiply_dict_leaves()
  • laurel.scenario_builders.ranger module
    • RangeScenarioBuilder
      • RangeScenarioBuilder.partition_level_names
    • RangeScenarioReader
      • RangeScenarioReader.builder
      • RangeScenarioReader.extract_metadata()
      • RangeScenarioReader.metadata_level_names
      • RangeScenarioReader.name_scenario()
  • laurel.scenario_builders.scale_test module
    • ScaleTestScenarioBuilder
      • ScaleTestScenarioBuilder.partition_level_names
    • ScaleTestScenarioReader
      • ScaleTestScenarioReader.builder
      • ScaleTestScenarioReader.extract_metadata()
      • ScaleTestScenarioReader.metadata_level_names
      • ScaleTestScenarioReader.name_scenario()
  • laurel.scenario_builders.sense module
    • Classes
    • Key design decisions
    • SenseScenarioBuilder
      • SenseScenarioBuilder.build_input_dist()
      • SenseScenarioBuilder.partition_level_names
    • SenseScenarioReader
      • SenseScenarioReader.builder
      • SenseScenarioReader.extract_metadata()
      • SenseScenarioReader.metadata_level_names
      • SenseScenarioReader.name_scenario()
  • Module contents
• laurel.scenario_framework package
  • Submodules
  • laurel.scenario_framework.build module
    • Key design decisions
    • ScenarioBuilder
      • ScenarioBuilder.__init__()
      • ScenarioBuilder.build_configs()
      • ScenarioBuilder.n_tasks_generated
      • ScenarioBuilder.partition_level_names
    • TestScenarioBuilder
      • TestScenarioBuilder.partition_level_names
  • laurel.scenario_framework.cmd module
    • Key design decisions
    • ScenarioBashWriter
      • ScenarioBashWriter.__init__()
      • ScenarioBashWriter.build_kedro_run()
      • ScenarioBashWriter.build_opts()
      • ScenarioBashWriter.build_slurm_request()
      • ScenarioBashWriter.compile()
    • generate_bash_script()
  • laurel.scenario_framework.io module
    • read_scenario_partition()
    • write_scenario_partition()
  • laurel.scenario_framework.nodes module
    • Usage
    • Key design decisions
    • generate_scenario_configs()
  • laurel.scenario_framework.read module
    • Typical post-hoc analysis workflow
    • Key design decisions
    • ScenarioReader
      • ScenarioReader.__init__()
      • ScenarioReader.builder
      • ScenarioReader.concat_name_components()
      • ScenarioReader.extract_metadata()
      • ScenarioReader.get_metadata_values()
      • ScenarioReader.list_completed_partitions()
      • ScenarioReader.metadata_level_names
      • ScenarioReader.name_scenario()
      • ScenarioReader.read_partitions()
      • ScenarioReader.scenario_name
      • ScenarioReader.select_partitions()
      • ScenarioReader.select_partitions_static()
    • TestScenarioReader
      • TestScenarioReader.builder
      • TestScenarioReader.extract_metadata()
      • TestScenarioReader.metadata_level_names
      • TestScenarioReader.name_scenario()
  • Module contents
• laurel.utils package
  • Submodules
  • laurel.utils.align module
    • calc_intersect_alignment()
    • calc_wasser_circle_distance()
  • laurel.utils.data module
    • Key design decisions
    • IndexIntegerizer
      • IndexIntegerizer.__init__()
      • IndexIntegerizer.deintegerize()
      • IndexIntegerizer.idx_names
      • IndexIntegerizer.int_col
      • IndexIntegerizer.integerize()
      • IndexIntegerizer.uniques
    • categorize_columns()
    • filter_by_vals_in_cols()
    • get_basic_dtype_ser()
    • get_merge_params()
    • get_multi_col_merger()
    • merge_dataframes_node()
    • merge_on_int_cols()
    • select_columns()
    • to_arrays()
  • laurel.utils.distributed module
    • Key design decisions
    • load_in_memory_node()
  • laurel.utils.events module
    • Key design decisions
    • get_events()
    • get_events_core()
    • get_events_wrapper()
  • laurel.utils.geo module
    • Key design decisions
    • calc_haversine_dist()
    • calc_max_dist_calipers()
    • calc_operating_radius()
    • find_time_weighted_centers()
  • laurel.utils.h3 module
    • Key design decisions
    • add_geometries()
    • cells_to_points()
    • cells_to_poly()
    • cells_to_polygons()
    • cells_to_region_polygons()
    • coords_to_cells()
    • coords_to_cells_wrapper()
    • region_polygons_to_cells()
    • str_to_h3()
    • to_geospatial()
  • laurel.utils.hex_neighbors module
    • Key design decisions
    • get_neighbor_embeddings()
    • get_ngbr_idxs()
    • get_ngbrs()
  • laurel.utils.infra module
    • build_nearest_infra_corresp()
    • build_utility_territory()
  • laurel.utils.location_grouping module
    • LocGroupingUniformityEvaluator
      • LocGroupingUniformityEvaluator.__init__()
      • LocGroupingUniformityEvaluator.set_cutoff()
      • LocGroupingUniformityEvaluator.summary()
      • LocGroupingUniformityEvaluator.summary_group()
      • LocGroupingUniformityEvaluator.summary_overall()
      • LocGroupingUniformityEvaluator.summary_raw()
  • laurel.utils.logging module
    • SuppressLogs
      • SuppressLogs.__init__()
  • laurel.utils.mapping module
    • map_dwells()
  • laurel.utils.mode_masks module
    • bits_to_bool_arr()
    • bits_to_bool_vec()
    • bool_arr_to_bits()
  • laurel.utils.naics module
    • get_naics_leaf_class()
  • laurel.utils.open_street_map module
    • RegexTagFilter
      • RegexTagFilter.__init__()
      • RegexTagFilter.node()
      • RegexTagFilter.relation()
      • RegexTagFilter.way()
    • get_gdf_from_filtered_osm()
    • processor_factory()
  • laurel.utils.params module
    • Key design decisions
    • build_df_from_dict()
    • extract_params()
    • flatten_dict()
    • import_from_config()
    • set_entity_params()
    • tabularize_params()
  • laurel.utils.plotting module
    • ProfileDensifier
      • ProfileDensifier.__init__()
      • ProfileDensifier.create_grouper()
      • ProfileDensifier.densify()
    • get_band_bounds()
    • plot_quantile_bands()
  • laurel.utils.sensitivity module
    • Key design decisions
    • SensitivityAnalysis
      • SensitivityAnalysis.__init__()
      • SensitivityAnalysis.calculate_sobols()
      • SensitivityAnalysis.fit_metamodel()
      • SensitivityAnalysis.plot_sobols()
    • correl_dict_to_matrix()
    • correl_matrix_to_dict()
  • laurel.utils.time module
    • Key design decisions
    • calc_avg_time_of_day()
    • calc_local_time()
    • calc_time_attrs()
    • calc_time_zones_from_hexes()
    • get_timezone_from_hex()
    • get_timezones()
    • get_total_time_units_filtered()
    • total_hours()
    • total_time_units()
  • Module contents

Submodules

laurel.pipeline_registry module

Project pipelines.

laurel.pipeline_registry.register_pipelines()

Register the project’s pipelines.

Return type:

dict[str, Pipeline]

Returns:

A mapping from pipeline names to Pipeline objects.

laurel.settings module

Project settings. There is no need to edit this file unless you want to change values from the Kedro defaults. For further information, including these default values, see https://docs.kedro.org/en/stable/kedro_project_setup/settings.html.

Module contents

EPA Phase III