prereise.gather package

Subpackages

• prereise.gather.demanddata package
  • Subpackages
    • prereise.gather.demanddata.bldg_electrification package
      • Subpackages
      • Submodules
      • prereise.gather.demanddata.bldg_electrification.const module
      • prereise.gather.demanddata.bldg_electrification.ff2elec_profile_generator_cook module
      • prereise.gather.demanddata.bldg_electrification.ff2elec_profile_generator_dhw module
      • prereise.gather.demanddata.bldg_electrification.ff2elec_profile_generator_htg module
      • prereise.gather.demanddata.bldg_electrification.ff_model module
      • prereise.gather.demanddata.bldg_electrification.floor_area_avg_slopes module
      • prereise.gather.demanddata.bldg_electrification.helper module
      • prereise.gather.demanddata.bldg_electrification.load_projection module
      • prereise.gather.demanddata.bldg_electrification.load_projection_scenario module
      • prereise.gather.demanddata.bldg_electrification.puma_data_agg module
      • prereise.gather.demanddata.bldg_electrification.puma_hp_estimator module
      • prereise.gather.demanddata.bldg_electrification.weather_data_agg module
      • prereise.gather.demanddata.bldg_electrification.zone_profile_generator module
      • Module contents
    • prereise.gather.demanddata.eia package
      • Subpackages
      • Submodules
      • prereise.gather.demanddata.eia.clean_data module
      • prereise.gather.demanddata.eia.get_eia_data module
      • prereise.gather.demanddata.eia.map_ba module
      • Module contents
    • prereise.gather.demanddata.nrel_efs package
      • Subpackages
      • Submodules
      • prereise.gather.demanddata.nrel_efs.aggregate_demand module
      • prereise.gather.demanddata.nrel_efs.get_efs_annual_data module
      • prereise.gather.demanddata.nrel_efs.get_efs_data module
      • prereise.gather.demanddata.nrel_efs.map_states module
      • Module contents
    • prereise.gather.demanddata.transportation_electrification package
      • Subpackages
      • Submodules
      • prereise.gather.demanddata.transportation_electrification.charging_optimization module
      • prereise.gather.demanddata.transportation_electrification.const module
      • prereise.gather.demanddata.transportation_electrification.data_helper module
      • prereise.gather.demanddata.transportation_electrification.data_process module
      • prereise.gather.demanddata.transportation_electrification.dwelling module
      • prereise.gather.demanddata.transportation_electrification.generate_BEV_vehicle_profiles module
      • prereise.gather.demanddata.transportation_electrification.generate_scaling_factors module
      • prereise.gather.demanddata.transportation_electrification.immediate module
      • prereise.gather.demanddata.transportation_electrification.immediate_charging_HDV module
      • prereise.gather.demanddata.transportation_electrification.smart_charging module
      • Module contents
  • Module contents
• prereise.gather.flexibilitydata package
  • Subpackages
    • prereise.gather.flexibilitydata.doe package
      • Subpackages
      • Submodules
      • prereise.gather.flexibilitydata.doe.batch_process module
      • prereise.gather.flexibilitydata.doe.bus_data module
      • prereise.gather.flexibilitydata.doe.doe_data module
      • prereise.gather.flexibilitydata.doe.geo_data module
      • Module contents
  • Module contents
• prereise.gather.griddata package
  • Subpackages
    • prereise.gather.griddata.transmission package
      • Subpackages
      • Submodules
      • prereise.gather.griddata.transmission.const module
      • prereise.gather.griddata.transmission.geometry module
      • prereise.gather.griddata.transmission.helpers module
      • Module contents
  • Module contents
• prereise.gather.hydrodata package
  • Subpackages
    • prereise.gather.hydrodata.eia package
      • Submodules
      • prereise.gather.hydrodata.eia.decompose_profile module
      • prereise.gather.hydrodata.eia.helpers module
      • prereise.gather.hydrodata.eia.interpolate_capacity_factors module
      • prereise.gather.hydrodata.eia.net_demand module
      • Module contents
  • Module contents
• prereise.gather.solardata package
  • Subpackages
    • prereise.gather.solardata.ga_wind package
      • Submodules
      • prereise.gather.solardata.ga_wind.ga_wind module
      • prereise.gather.solardata.ga_wind.helpers module
      • Module contents
    • prereise.gather.solardata.nsrdb package
      • Subpackages
      • Submodules
      • prereise.gather.solardata.nsrdb.naive module
      • prereise.gather.solardata.nsrdb.nrel_api module
      • prereise.gather.solardata.nsrdb.sam module
      • Module contents
    • prereise.gather.solardata.tests package
      • Submodules
      • prereise.gather.solardata.tests.mock_pv_info module
      • prereise.gather.solardata.tests.test_helpers module
      • prereise.gather.solardata.tests.test_pv_tracking module
      • Module contents
  • Submodules
  • prereise.gather.solardata.helpers module
    • get_plant_id_unique_location()
    • to_reise()
  • prereise.gather.solardata.pv_tracking module
    • get_pv_tracking_data()
    • get_pv_tracking_ratio_state()
  • Module contents
• prereise.gather.tests package
  • Submodules
  • prereise.gather.tests.mock_generation module
    • create_mock_generation_data_frame()
  • prereise.gather.tests.test_helpers module
    • test_get_monthly_net_generation()
    • test_get_monthly_net_generation_argument_type()
    • test_get_monthly_net_generation_argument_value()
  • prereise.gather.tests.test_rate_limit module
    • SleepCounter
      • SleepCounter.sleep()
      • SleepCounter.time()
    • sleepless()
    • test_decorator_with_default()
    • test_decorator_with_limit()
    • test_default_no_limit()
    • test_sleep_occurrs()
  • prereise.gather.tests.test_retry module
    • CustomError
    • test_counter_attribute()
    • test_decorate_without_call()
    • test_max_times_reached()
    • test_raises_after_max_attempts()
    • test_return_value()
    • test_unhandled_exception()
  • Module contents
• prereise.gather.winddata package
  • Subpackages
    • prereise.gather.winddata.hrrr package
      • Subpackages
      • Submodules
      • prereise.gather.winddata.hrrr.calculations module
      • prereise.gather.winddata.hrrr.constants module
      • prereise.gather.winddata.hrrr.downloader module
      • prereise.gather.winddata.hrrr.grib module
      • prereise.gather.winddata.hrrr.helpers module
      • prereise.gather.winddata.hrrr.hrrr module
      • prereise.gather.winddata.hrrr.hrrr_api module
      • Module contents
    • prereise.gather.winddata.rap package
      • Subpackages
      • Submodules
      • prereise.gather.winddata.rap.helpers module
      • prereise.gather.winddata.rap.noaa_api module
      • prereise.gather.winddata.rap.rap module
      • Module contents
  • Submodules
  • prereise.gather.winddata.const module
  • prereise.gather.winddata.impute module
    • gaussian()
    • linear()
    • simple()
  • prereise.gather.winddata.power_curves module
    • build_state_curves()
    • get_form_860()
    • get_power()
    • get_state_power_curves()
    • get_turbine_power_curves()
    • shift_turbine_curve()
  • Module contents

Submodules

prereise.gather.const module

prereise.gather.helpers module

prereise.gather.helpers.get_monthly_net_generation(state, eia_form_923, resource, hps=True)

Return monthly total net generation for a given resource and state from EIA form 923.

Parameters:

• state (str) – state abbreviation.

• eia_form_923 (pandas.DataFrame) – EIA form 923. The reduced form as returned by trim_eia_form_923() can be used.

• resource (str) – type of generator.

• hps (bool) – determine whether pumped hydro storage is included in the result if resource is ‘hydro’.

Returns:

(list) – monthly net generation of the query fuel type in state.

Raises:

• TypeError – if eia_form_923 is not a data frame or resource is not a str.

• ValueError – if state or resource is invalid.

prereise.gather.helpers.trim_eia_form_923(filename)

Remove columns in EIA form 923 that are unnecessary to calculate the monthly generation per resource as performed by get_monthly_net_generation().

Parameters:

filename (str) – name of the reference file.

Returns:

(pandas.DataFrame) – EIA form 923 with only relevant columns.

prereise.gather.request_util module

class prereise.gather.request_util.RateLimit(interval=None)

Bases: object

Provides a way to call an arbitrary function at most once per interval.

Parameters:

interval (int/float) – the amount of time in seconds to wait between actions

invoke(action)

Call the action and return its value, waiting if necessary

Parameters:

action (callable) – the thing to do

Returns:

(Any) – the return value of the action

exception prereise.gather.request_util.TransientError

Bases: Exception

Used for errors which can be retried

prereise.gather.request_util.rate_limit(_func=None, interval=None)

prereise.gather.request_util.retry(_func=None, max_attempts=5, interval=None, raises=False, allowed_exceptions=<class 'urllib.error.HTTPError'>)

Creates a decorator to handle retry logic.

Parameters:

• max_attempts (int) – the max number of retries

• interval (int/float) – minimum spacing between retries

• raises (bool) – whether to re-raise the error after max_attempts is reached

• allowed_exceptions (tuple) – exceptions for which the function will be retried, all others will be surfaced to the caller

Returns:

(Any) – the return value of the decorated function, or None if raises is False and all attempts failed

Module contents