build_datapackage

Inputs

scenario_specsstr

scenarios/{scenario}.yml: path of input file (.yml) containing scenario specifications

destinationstr

results/{scenario}/preprocessed: path of output directory

logfilestr

results/{scenario}/{scenario}.log: path to logfile

Outputs

oemoflex.EnergyDatapackage

EnergyDatapackage that can be read by oemof.tabular, with data (scalars and timeseries) as csv and metadata (describing resources and foreign key relations) as json.

Description

The script creates an empty EnergyDatapackage from the specifications given in the scenario_specs, fills it with scalar and timeseries data, infers the metadata and saves it to the given destination. Further, additional parameters like emission limit are saved in a separate file.

Explanations about the structure of the preprocessed datapackage can be found in section Build datapackages of the docu.

build_datapackage.calculate_emission_limit(emissions_1990, emissions_not_modeled, emission_reduction_factor)

Calculates the emission limit. Emission limit is calculated by emissions_1990 * (1 - emission_reduction_factor) - emissions_not_modeled

build_datapackage.load_additional_scalars(scalars, filters)

Loads additional scalars like the emission limit and filters by ‘scenario_key’

build_datapackage.parametrize_scalars(edp, scalars, filters)

Parametrizes an oemoflex.EnergyDataPackage with scalars. Accepts an OrderedDict of filters that is used to filter the scalars and subsequently update the EnergyDatapackage.

Parameters:
  • edp (oemoflex.EnergyDatapackage) – EnergyDatapackage to parametrize

  • scalars (pd.DataFrame in oemof_B3-Resources format.) – Scalar data

  • filters (OrderedDict) – Filters for the scalar data

Returns:

edp – Parametrized EnergyDatapackage

Return type:

oemoflex.EnergyDatapackage

build_datapackage.parametrize_sequences(edp, ts, filters)

Parametrizes an oemoflex.EnergyDataPackage with timeseries.

Parameters:
  • edp (oemoflex.EnergyDatapackage) – EnergyDatapackage to parametrize

  • ts (pd.DataFrame in oemof_B3-Resources format.) – Timeseries data

  • filters (dict) – Filters for timeseries data

Returns:

edp – Parametrized EnergyDatapackage

Return type:

oemoflex.EnergyDatapackage

build_datapackage.save_additional_scalars(additional_scalars, destination)

Saves additional_scalars to additional_scalar_file in destination

build_datapackage.update_with_checks(old, new)

Updates a Series or DataFrame with new data. Raises a warning if there is new data that is not in the index of the old data.

Parameters:
  • old (pd.Series or pd.DataFrame) – Old Series or DataFrame to update

  • new (pd.Series or pd.DataFrame) – New Series or DataFrame

Return type:

None