scenario_builder.feedin.scenario_feedin()

Complexity

Conditions

2

Size

Total Lines	38
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

0

"""Create a basic scenario from the internal data structure.
def scenario_feedin(regions, year, name, weather_year=None):
    """

    Parameters
    ----------
    regions
    year
    name
    weather_year

    Returns
    -------

    Examples
    --------
    >>> from reegis import geometries  # doctest: +SKIP
    >>> fs=geometries.get_federal_states_polygon()  # doctest: +SKIP
    >>> f = scenario_feedin(regions, 2014, "fs")  # doctest: +SKIP
    >>> f["NI"].sum()  # doctest: +SKIP
    geothermal    4380.000000
    hydro         2242.134748
    solar          831.424963
    wind          2602.090478
    dtype: float64
    >>> f["BY"].sum()  # doctest: +SKIP
    geothermal    4380.000000
    hydro         2242.134748
    solar          849.019372
    wind          1279.604124
    dtype: float64
    """
    wy = weather_year
    try:
        feedin = coastdat.scenario_feedin(year, name, weather_year=wy)
    except FileNotFoundError:
        coastdat.get_feedin_per_region(year, regions, name, weather_year=wy)
        feedin = coastdat.scenario_feedin(year, name, weather_year=wy)
    return feedin