dynamic-characterization 0.0.1.dev1__tar.gz → 0.0.2__tar.gz

{dynamic_characterization-0.0.1.dev1/dynamic_characterization.egg-info → dynamic_characterization-0.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dynamic_characterization
-Version: 0.0.1.dev1
+Version: 0.0.2
 Summary: Collection of dynamic characterization functions for life cycle inventories with temporal information
 Author-email: Timo Diepers <timo.diepers@ltt.rwth-aachen.de>
 Maintainer-email: Timo Diepers <timo.diepers@ltt.rwth-aachen.de>
@@ -20,6 +20,8 @@ Classifier: Topic :: Scientific/Engineering
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: pandas
+Requires-Dist: numpy
 Provides-Extra: testing
 Requires-Dist: dynamic_characterization; extra == "testing"
 Requires-Dist: pytest; extra == "testing"

{dynamic_characterization-0.0.1.dev1 → dynamic_characterization-0.0.2}/dynamic_characterization/__init__.py

@@ -9,7 +9,7 @@ __all__ = (
     # Add functions and variables you want exposed in `dynamic_characterization.` namespace here
 )
 
-__version__ = "0.0.1dev1"
+__version__ = "0.0.2"
 
 from . import temporalis
 from . import timex

dynamic_characterization-0.0.2/dynamic_characterization/temporalis/__init__.py

@@ -0,0 +1,15 @@
+"""
+Dynamic characterization functions from the bw_temporalis package (https://github.com/brightway-lca/bw_temporalis).
+"""
+
+__all__ = (
+    "__version__",
+    "characterize_co2",
+    "characterize_methane",
+    # Add functions and variables you want exposed in `dynamic_characterization.` namespace here
+)
+
+__version__ = "0.0.1"
+
+from .radiative_forcing import characterize_co2
+from .radiative_forcing import characterize_methane

dynamic_characterization-0.0.2/dynamic_characterization/temporalis/radiative_forcing.py

@@ -0,0 +1,139 @@
+import numpy as np
+import pandas as pd
+
+
+def characterize_co2(
+    series,
+    period: int | None = 100,
+    cumulative: bool | None = False,
+) -> pd.DataFrame:
+    """
+    Calculate the cumulative or marginal radiative forcing (CRF) from CO2 for each year in a given period.
+
+    If `cumulative` is True, the cumulative CRF is calculated. If `cumulative` is False, the marginal CRF is calculated.
+    Takes a single row of the TimeSeries Pandas DataFrame (corresponding to a set of (`date`/`amount`/`flow`/`activity`).
+    For each year in the given period, the CRF is calculated.
+    Units are watts/square meter/kilogram of CO2.
+
+    Returns
+    -------
+    A TimeSeries dataframe with the following columns:
+    - date: datetime64[s]
+    - amount: float
+    - flow: str
+    - activity: str
+
+    Notes
+    -----
+    See also the relevant scientific publication on CRF: https://doi.org/10.5194/acp-13-2793-2013
+    See also the relevant scientific publication on the numerical calculation of CRF: http://pubs.acs.org/doi/abs/10.1021/acs.est.5b01118
+
+    See Also
+    --------
+    characterize_methane: The same function for CH4
+    """
+
+    # functional variables and units (from publications listed in docstring)
+    RE = 1.76e-15  # Radiative forcing (W/m2/kg)
+    alpha_0, alpha_1, alpha_2, alpha_3 = 0.2173, 0.2240, 0.2824, 0.2763
+    tau_1, tau_2, tau_3 = 394.4, 36.54, 4.304
+    decay_term = lambda year, alpha, tau: alpha * tau * (1 - np.exp(-year / tau))
+
+    date_beginning: np.datetime64 = series["date"].to_numpy()
+    date_characterized: np.ndarray = date_beginning + np.arange(
+        start=0, stop=period, dtype="timedelta64[Y]"
+    ).astype("timedelta64[s]")
+
+    decay_multipliers: np.ndarray = np.array(
+        [
+            RE
+            * (
+                alpha_0 * year
+                + decay_term(year, alpha_1, tau_1)
+                + decay_term(year, alpha_2, tau_2)
+                + decay_term(year, alpha_3, tau_3)
+            )
+            for year in range(period)
+        ]
+    )
+
+    forcing = pd.Series(data=series.amount * decay_multipliers, dtype="float64")
+    if not cumulative:
+        forcing = forcing.diff(periods=1).fillna(0)
+
+    return pd.DataFrame(
+        {
+            "date": pd.Series(data=date_characterized, dtype="datetime64[s]"),
+            "amount": forcing,
+            "flow": series.flow,
+            "activity": series.activity,
+        }
+    )
+
+
+def characterize_methane(series, period: int = 100, cumulative=False) -> pd.DataFrame:
+    """
+    Calculate the cumulative or marginal radiative forcing (CRF) from CH4 for each year in a given period.
+
+    If `cumulative` is True, the cumulative CRF is calculated. If `cumulative` is False, the marginal CRF is calculated.
+    Takes a single row of the TimeSeries Pandas DataFrame (corresponding to a set of (`date`/`amount`/`flow`/`activity`).
+    For earch year in the given period, the CRF is calculated.
+    Units are watts/square meter/kilogram of CH4.
+
+    Parameters
+    ----------
+    series : array-like
+        A single row of the TimeSeries dataframe.
+    period : int, optional
+        Time period for calculation (number of years), by default 100
+    cumulative : bool, optional
+        Should the RF amounts be summed over time?
+
+    Returns
+    -------
+    A TimeSeries dataframe with the following columns:
+    - date: datetime64[s]
+    - amount: float
+    - flow: str
+    - activity: str
+
+    Notes
+    -----
+    See also the relevant scientific publication on CRF: https://doi.org/10.5194/acp-13-2793-2013
+    See also the relevant scientific publication on the numerical calculation of CRF: http://pubs.acs.org/doi/abs/10.1021/acs.est.5b01118
+
+    See Also
+    --------
+    characterize_co2: The same function for CO2
+    """
+
+    # functional variables and units (from publications listed in docstring)
+    f1 = 0.5  # Unitless
+    f2 = 0.15  # Unitless
+    alpha = 1.27e-13  # Radiative forcing (W/m2/kg)
+    tau = 12.4  # Lifetime (years)
+
+    date_beginning: np.datetime64 = series["date"].to_numpy()
+    date_characterized: np.ndarray = date_beginning + np.arange(
+        start=0, stop=period, dtype="timedelta64[Y]"
+    ).astype("timedelta64[s]")
+
+    decay_multipliers: list = np.array(
+        [
+            (1 + f1 + f2) * alpha * tau * (1 - np.exp(-year / tau))
+            for year in range(period)
+        ]
+    )
+
+    forcing = pd.Series(data=series.amount * decay_multipliers, dtype="float64")
+    if not cumulative:
+        forcing = forcing.diff(periods=1).fillna(0)
+
+    return pd.DataFrame(
+        {
+            "date": pd.Series(data=date_characterized, dtype="datetime64[s]"),
+            "amount": forcing,
+            "flow": series.flow,
+            "activity": series.activity,
+        }
+    )

dynamic_characterization-0.0.2/dynamic_characterization/timex/__init__.py

@@ -0,0 +1,23 @@
+"""
+Dynamic characterization functions from the bw_timex package (https://github.com/brightway-lca/bw_timex).
+"""
+
+__all__ = (
+    "__version__",
+    "characterize_co2",
+    "characterize_co2_uptake",
+    "characterize_co",
+    "characterize_ch4",
+    "characterize_n2o",
+    "create_generic_characterization_function",
+    # Add functions and variables you want exposed in `dynamic_characterization.` namespace here
+)
+
+__version__ = "0.0.1"
+
+from .radiative_forcing import characterize_co2
+from .radiative_forcing import characterize_co2_uptake
+from .radiative_forcing import characterize_co
+from .radiative_forcing import characterize_ch4
+from .radiative_forcing import characterize_n2o
+from .radiative_forcing import create_generic_characterization_function

dynamic_characterization-0.0.2/dynamic_characterization/timex/radiative_forcing.py

@@ -0,0 +1,482 @@
+import pandas as pd
+import numpy as np
+
+
+def IRF_co2(year) -> callable:
+    """
+    Impulse Resonse Function (IRF) of CO2
+
+    Parameters
+    ----------
+    year : int
+        The year after emission for which the IRF is calculated.
+    
+    Returns
+    -------
+    float
+        The IRF value for the given year.
+
+    """
+    alpha_0, alpha_1, alpha_2, alpha_3 = 0.2173, 0.2240, 0.2824, 0.2763
+    tau_1, tau_2, tau_3 = 394.4, 36.54, 4.304
+    exponentials = lambda year, alpha, tau: alpha * tau * (1 - np.exp(-year / tau))
+    return (
+        alpha_0 * year
+        + exponentials(year, alpha_1, tau_1)
+        + exponentials(year, alpha_2, tau_2)
+        + exponentials(year, alpha_3, tau_3)
+    )
+
+
+def characterize_co2(
+    series,
+    period: int | None = 100,
+    cumulative: bool | None = False,
+) -> pd.DataFrame:
+    """
+    Calculate the cumulative or marginal radiative forcing (CRF) from CO2 for each year in a given period.
+    
+    Based on characterize_co2 from bw_temporalis, but updated numerical values from IPCC AR6 Ch7 & SM.
+
+    If `cumulative` is True, the cumulative CRF is calculated. If `cumulative` is False, the marginal CRF is calculated.
+    Takes a single row of the TimeSeries Pandas DataFrame (corresponding to a set of (`date`/`amount`/`flow`/`activity`).
+    For each year in the given period, the CRF is calculated.
+    Units are watts/square meter/kilogram of CO2.
+
+    Returns
+    -------
+    A TimeSeries dataframe with the following columns:
+    - date: datetime64[s]
+    - amount: float
+    - flow: str
+    - activity: str
+
+    See also
+    --------
+    Joos2013: Relevant scientific publication on CRF: https://doi.org/10.5194/acp-13-2793-2013
+    Schivley2015: Relevant scientific publication on the numerical calculation of CRF: https://doi.org/10.1021/acs.est.5b01118
+    Forster2023: Updated numerical values from IPCC AR6 Chapter 7 (Table 7.15): https://doi.org/10.1017/9781009157896.009
+    """
+
+    # functional variables and units (from publications listed in docstring)
+    radiative_efficiency_ppb = (
+        1.33e-5  # W/m2/ppb; 2019 background co2 concentration; IPCC AR6 Table 7.15
+    )
+
+    # for conversion from ppb to kg-CO2
+    M_co2 = 44.01  # g/mol
+    M_air = 28.97  # g/mol, dry air
+    m_atmosphere = 5.135e18  # kg [Trenberth and Smith, 2005]
+
+    radiative_efficiency_kg = (
+        radiative_efficiency_ppb * M_air / M_co2 * 1e9 / m_atmosphere
+    )  # W/m2/kg-CO2
+
+    date_beginning: np.datetime64 = series["date"].to_numpy()
+    date_characterized: np.ndarray = date_beginning + np.arange(
+        start=0, stop=period, dtype="timedelta64[Y]"
+    ).astype("timedelta64[s]")
+
+    decay_multipliers: np.ndarray = np.array(
+        [radiative_efficiency_kg * IRF_co2(year) for year in range(period)]
+    )
+
+    forcing = pd.Series(data=series.amount * decay_multipliers, dtype="float64")
+
+    if not cumulative:
+        forcing = forcing.diff(periods=1).fillna(0)
+
+    return pd.DataFrame(
+        {
+            "date": pd.Series(data=date_characterized, dtype="datetime64[s]"),
+            "amount": forcing,
+            "flow": series.flow,
+            "activity": series.activity,
+        }
+    )
+
+
+def characterize_co2_uptake(
+    series,
+    period: int | None = 100,
+    cumulative: bool | None = False,
+) -> pd.DataFrame:
+    """
+    The same as characterize_co2, but with a negative sign for uptake of CO2.
+
+    Based on characterize_co2 from bw_temporalis, but updated numerical values from IPCC AR6 Ch7 & SM.
+
+    Calculate the negative cumulative or marginal radiative forcing (CRF) from CO2-uptake for each year in a given period.
+
+    If `cumulative` is True, the cumulative CRF is calculated. If `cumulative` is False, the marginal CRF is calculated.
+    Takes a single row of the TimeSeries Pandas DataFrame (corresponding to a set of (`date`/`amount`/`flow`/`activity`).
+    For each year in the given period, the CRF is calculated.
+    Units are watts/square meter/kilogram of CO2.
+
+    Returns
+    -------
+    A TimeSeries dataframe with the following columns:
+    - date: datetime64[s]
+    - amount: float
+    - flow: str
+    - activity: str
+
+    See also
+    --------
+    Joos2013: Relevant scientific publication on CRF: https://doi.org/10.5194/acp-13-2793-2013
+    Schivley2015: Relevant scientific publication on the numerical calculation of CRF: https://doi.org/10.1021/acs.est.5b01118
+    Forster2023: Updated numerical values from IPCC AR6 Chapter 7 (Table 7.15): https://doi.org/10.1017/9781009157896.009
+    """
+
+    # functional variables and units (from publications listed in docstring)
+    radiative_efficiency_ppb = (
+        1.33e-5  # W/m2/ppb; 2019 background co2 concentration; IPCC AR6 Table 7.15
+    )
+
+    # for conversion from ppb to kg-CO2
+    M_co2 = 44.01  # g/mol
+    M_air = 28.97  # g/mol, dry air
+    m_atmosphere = 5.135e18  # kg [Trenberth and Smith, 2005]
+
+    radiative_efficiency_kg = (
+        radiative_efficiency_ppb * M_air / M_co2 * 1e9 / m_atmosphere
+    )  # W/m2/kg-CO2
+
+    date_beginning: np.datetime64 = series["date"].to_numpy()
+    date_characterized: np.ndarray = date_beginning + np.arange(
+        start=0, stop=period, dtype="timedelta64[Y]"
+    ).astype("timedelta64[s]")
+
+    decay_multipliers: np.ndarray = np.array(
+        [radiative_efficiency_kg * IRF_co2(year) for year in range(period)]
+    )
+
+    forcing = pd.Series(data=series.amount * decay_multipliers, dtype="float64")
+
+    forcing = (
+        -forcing
+    )  # flip the sign of the characterization function for CO2 uptake and not release
+
+    if not cumulative:
+        forcing = forcing.diff(periods=1).fillna(0)
+
+    return pd.DataFrame(
+        {
+            "date": pd.Series(data=date_characterized, dtype="datetime64[s]"),
+            "amount": forcing,
+            "flow": series.flow,
+            "activity": series.activity,
+        }
+    )
+
+
+def characterize_co(
+    series,
+    period: int | None = 100,
+    cumulative: bool | None = False,
+) -> pd.DataFrame:
+    """
+    Calculate the cumulative or marginal radiative forcing (CRF) from CO for each year in a given period.
+
+    This is exactly the same function as for CO2, it's just scaled by the ratio of molar masses of CO and CO2. This is because CO is very short-lived (lifetime ~2 months) and we assume that it completely reacts to CO2 within the first year.
+
+    Based on characterize_co2 from bw_temporalis, but updated numerical values from IPCC AR6 Ch7 & SM.
+
+    Calculate the cumulative or marginal radiative forcing (CRF) from CO2 for each year in a given period.
+
+    If `cumulative` is True, the cumulative CRF is calculated. If `cumulative` is False, the marginal CRF is calculated.
+    Takes a single row of the TimeSeries Pandas DataFrame (corresponding to a set of (`date`/`amount`/`flow`/`activity`).
+    For each year in the given period, the CRF is calculated.
+    Units are watts/square meter/kilogram of CO2.
+
+    Returns
+    -------
+    A TimeSeries dataframe with the following columns:
+    - date: datetime64[s]
+    - amount: float
+    - flow: str
+    - activity: str
+
+    See also
+    --------
+    Joos2013: Relevant scientific publication on CRF: https://doi.org/10.5194/acp-13-2793-2013
+    Schivley2015: Relevant scientific publication on the numerical calculation of CRF: https://doi.org/10.1021/acs.est.5b01118
+    Forster2023: Updated numerical values from IPCC AR6 Chapter 7 (Table 7.15): https://doi.org/10.1017/9781009157896.009
+    """
+
+    # functional variables and units (from publications listed in docstring)
+    radiative_efficiency_ppb = (
+        1.33e-5  # W/m2/ppb; 2019 background co2 concentration; IPCC AR6 Table 7.15
+    )
+
+    # for conversion from ppb to kg-CO2
+    M_co2 = 44.01  # g/mol
+    M_co = 28.01   # g/mol
+    M_air = 28.97  # g/mol, dry air
+    m_atmosphere = 5.135e18  # kg [Trenberth and Smith, 2005]
+
+    radiative_efficiency_kg = (
+        radiative_efficiency_ppb * M_air / M_co2 * 1e9 / m_atmosphere
+    )  # W/m2/kg-CO2
+
+    date_beginning: np.datetime64 = series["date"].to_numpy()
+    date_characterized: np.ndarray = date_beginning + np.arange(
+        start=0, stop=period, dtype="timedelta64[Y]"
+    ).astype("timedelta64[s]")
+
+    decay_multipliers: np.ndarray = np.array(
+        [
+            M_co2 / M_co * radiative_efficiency_kg * IRF_co2(year)
+            for year in range(period)
+        ]  # <-- Scaling from co2 to co is done here
+    )
+
+    forcing = pd.Series(data=series.amount * decay_multipliers, dtype="float64")
+
+    if not cumulative:
+        forcing = forcing.diff(periods=1).fillna(0)
+
+    return pd.DataFrame(
+        {
+            "date": pd.Series(data=date_characterized, dtype="datetime64[s]"),
+            "amount": forcing,
+            "flow": series.flow,
+            "activity": series.activity,
+        }
+    )
+
+
+def characterize_ch4(
+    series,
+    period: int = 100,
+    cumulative=False,
+) -> pd.DataFrame:
+    """
+    Calculate the cumulative or marginal radiative forcing (CRF) from CH4 for each year in a given period. 
+
+    Based on characterize_methane from bw_temporalis, but updated numerical values from IPCC AR6 Ch7 & SM.
+    
+    This DOES include indirect effects of CH4 on ozone and water vapor, but DOES NOT include the decay to CO2. 
+    For more info on that, see the deprecated version of bw_temporalis.
+
+    If `cumulative` is True, the cumulative CRF is calculated. If `cumulative` is False, the marginal CRF is calculated.
+    Takes a single row of the TimeSeries Pandas DataFrame (corresponding to a set of (`date`/`amount`/`flow`/`activity`).
+    For earch year in the given period, the CRF is calculated.
+    Units are watts/square meter/kilogram of CH4.
+
+    Parameters
+    ----------
+    series : array-like
+        A single row of the TimeSeries dataframe.
+    period : int, optional
+        Time period for calculation (number of years), by default 100
+    cumulative : bool, optional
+        Should the RF amounts be summed over time?
+
+    Returns
+    -------
+    A TimeSeries dataframe with the following columns:
+    - date: datetime64[s]
+    - amount: float
+    - flow: str
+    - activity: str
+
+    See also
+    --------
+    Joos2013: Relevant scientific publication on CRF: https://doi.org/10.5194/acp-13-2793-2013
+    Schivley2015: Relevant scientific publication on the numerical calculation of CRF: https://doi.org/10.1021/acs.est.5b01118
+    Forster2023: Updated numerical values from IPCC AR6 Chapter 7 (Table 7.15): https://doi.org/10.1017/9781009157896.009
+    """
+
+    # functional variables and units (from publications listed in docstring)
+    radiative_efficiency_ppb = 5.7e-4  # # W/m2/ppb; 2019 background cch4 concentration; IPCC AR6 Table 7.15. This number includes indirect effects.
+
+    # for conversion from ppb to kg-CH4
+    M_ch4 = 16.04  # g/mol
+    M_air = 28.97  # g/mol, dry air
+    m_atmosphere = 5.135e18  # kg [Trenberth and Smith, 2005]
+
+    radiative_efficiency_kg = (
+        radiative_efficiency_ppb * M_air / M_ch4 * 1e9 / m_atmosphere
+    )  # W/m2/kg-CH4
+
+    tau = 11.8  # Lifetime (years)
+
+    date_beginning: np.datetime64 = series["date"].to_numpy()
+    date_characterized: np.ndarray = date_beginning + np.arange(
+        start=0, stop=period, dtype="timedelta64[Y]"
+    ).astype("timedelta64[s]")
+
+    decay_multipliers: list = np.array(
+        [
+            radiative_efficiency_kg * tau * (1 - np.exp(-year / tau))
+            for year in range(period)
+        ]
+    )
+
+    forcing = pd.Series(data=series.amount * decay_multipliers, dtype="float64")
+
+    if not cumulative:
+        forcing = forcing.diff(periods=1).fillna(0)
+
+    return pd.DataFrame(
+        {
+            "date": pd.Series(data=date_characterized, dtype="datetime64[s]"),
+            "amount": forcing,
+            "flow": series.flow,
+            "activity": series.activity,
+        }
+    )
+
+
+def characterize_n2o(
+    series,
+    period: int = 100,
+    cumulative=False,
+) -> pd.DataFrame:
+    """
+    Calculate the cumulative or marginal radiative forcing (CRF) from N2O for each year in a given period.
+    
+    Based on characterize_methane from bw_temporalis, but updated numerical values from IPCC AR6 Ch7 & SM.
+   
+    If `cumulative` is True, the cumulative CRF is calculated. If `cumulative` is False, the marginal CRF is calculated.
+    Takes a single row of the TimeSeries Pandas DataFrame (corresponding to a set of (`date`/`amount`/`flow`/`activity`).
+    For earch year in the given period, the CRF is calculated.
+    Units are watts/square meter/kilogram of N2O.
+
+    Parameters
+    ----------
+    series : array-like
+        A single row of the TimeSeries dataframe.
+    period : int, optional
+        Time period for calculation (number of years), by default 100
+    cumulative : bool, optional
+        Should the RF amounts be summed over time?
+
+    Returns
+    -------
+    A TimeSeries dataframe with the following columns:
+    - date: datetime64[s]
+    - amount: float
+    - flow: str
+    - activity: str
+
+    See also
+    --------
+    Joos2013: Relevant scientific publication on CRF: https://doi.org/10.5194/acp-13-2793-2013
+    Schivley2015: Relevant scientific publication on the numerical calculation of CRF: https://doi.org/10.1021/acs.est.5b01118
+    Forster2023: Updated numerical values from IPCC AR6 Chapter 7 (Table 7.15): https://doi.org/10.1017/9781009157896.009
+    """
+
+    # functional variables and units (from publications listed in docstring)
+    radiative_efficiency_ppb = 2.8e-3  # # W/m2/ppb; 2019 background cch4 concentration; IPCC AR6 Table 7.15. This number includes indirect effects.
+
+    # for conversion from ppb to kg-CH4
+    M_n2o = 44.01  # g/mol
+    M_air = 28.97  # g/mol, dry air
+    m_atmosphere = 5.135e18  # kg [Trenberth and Smith, 2005]
+
+    radiative_efficiency_kg = (
+        radiative_efficiency_ppb * M_air / M_n2o * 1e9 / m_atmosphere
+    )  # W/m2/kg-N2O
+
+    tau = 109  # Lifetime (years)
+
+    date_beginning: np.datetime64 = series["date"].to_numpy()
+    date_characterized: np.ndarray = date_beginning + np.arange(
+        start=0, stop=period, dtype="timedelta64[Y]"
+    ).astype("timedelta64[s]")
+
+    decay_multipliers: list = np.array(
+        [
+            radiative_efficiency_kg * tau * (1 - np.exp(-year / tau))
+            for year in range(period)
+        ]
+    )
+
+    forcing = pd.Series(data=series.amount * decay_multipliers, dtype="float64")
+    if not cumulative:
+        forcing = forcing.diff(periods=1).fillna(0)
+
+    return pd.DataFrame(
+        {
+            "date": pd.Series(data=date_characterized, dtype="datetime64[s]"),
+            "amount": forcing,
+            "flow": series.flow,
+            "activity": series.activity,
+        }
+    )
+
+
+def create_generic_characterization_function(decay_series) -> pd.DataFrame:
+    """
+    Creates a characterization function for a GHG based on a decay series, by calling the nested method `characterize_generic()`.
+    
+    Parameters
+    ----------
+    decay_series : np.ndarray
+        A decay series for a specific GHG. This is retrieved from `../data/decay_multipliers.pkl`
+
+    Returns
+    -------
+    A function called `characterize_generic`, which in turn returns a TimeSeries dataframe that contains the forcing of the emission of the row over the given period based on the decay series of that biosphere flow.
+
+    """
+
+    def characterize_generic(
+        series,
+        period: int = 100,
+        cumulative=False,
+    ) -> pd.DataFrame:
+        """
+        Uses lookup generated in /dev/calculate_metrics.ipynb
+        Data originates from https://doi.org/10.1029/2019RG000691
+
+        Parameters
+        ----------
+        series : array-like
+            A single row of the dynamic inventory dataframe.
+        period : int, optional
+            Time period for calculation (number of years), by default 100
+        cumulative : bool,
+            cumulative impact
+
+        Returns
+        -------
+        A TimeSeries dataframe that contains the forcing of the point emission from the row for each year in the given period.
+          date: datetime64[s]
+          amount: float (forcing at this timestep)
+          flow: str
+          activity: str
+          
+        See also
+        --------
+        Joos2013: Relevant scientific publication on CRF: https://doi.org/10.5194/acp-13-2793-2013
+        Schivley2015: Relevant scientific publication on the numerical calculation of CRF: https://doi.org/10.1021/acs.est.5b01118
+        Forster2023: Updated numerical values from IPCC AR6 Chapter 7 (Table 7.15): https://doi.org/10.1017/9781009157896.009
+
+        """
+
+        date_beginning: np.datetime64 = series["date"].to_numpy()
+
+        dates_characterized: np.ndarray = date_beginning + np.arange(
+            start=0, stop=period, dtype="timedelta64[Y]"
+        ).astype("timedelta64[s]")
+
+        decay_multipliers = decay_series[:period]
+
+        forcing = pd.Series(data=series.amount * decay_multipliers, dtype="float64")
+
+        if not cumulative:
+            forcing = forcing.diff(periods=1).fillna(0)
+
+        return pd.DataFrame(
+            {
+                "date": pd.Series(data=dates_characterized, dtype="datetime64[s]"),
+                "amount": forcing,
+                "flow": series.flow,
+                "activity": series.activity,
+            }
+        )
+
+    return characterize_generic

{dynamic_characterization-0.0.1.dev1 → dynamic_characterization-0.0.2/dynamic_characterization.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dynamic_characterization
-Version: 0.0.1.dev1
+Version: 0.0.2
 Summary: Collection of dynamic characterization functions for life cycle inventories with temporal information
 Author-email: Timo Diepers <timo.diepers@ltt.rwth-aachen.de>
 Maintainer-email: Timo Diepers <timo.diepers@ltt.rwth-aachen.de>
@@ -20,6 +20,8 @@ Classifier: Topic :: Scientific/Engineering
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: pandas
+Requires-Dist: numpy
 Provides-Extra: testing
 Requires-Dist: dynamic_characterization; extra == "testing"
 Requires-Dist: pytest; extra == "testing"

{dynamic_characterization-0.0.1.dev1 → dynamic_characterization-0.0.2}/dynamic_characterization.egg-info/SOURCES.txt

@@ -7,4 +7,8 @@ dynamic_characterization.egg-info/PKG-INFO
 dynamic_characterization.egg-info/SOURCES.txt
 dynamic_characterization.egg-info/dependency_links.txt
 dynamic_characterization.egg-info/requires.txt
-dynamic_characterization.egg-info/top_level.txt
+dynamic_characterization.egg-info/top_level.txt
+dynamic_characterization/temporalis/__init__.py
+dynamic_characterization/temporalis/radiative_forcing.py
+dynamic_characterization/timex/__init__.py
+dynamic_characterization/timex/radiative_forcing.py

{dynamic_characterization-0.0.1.dev1 → dynamic_characterization-0.0.2}/dynamic_characterization.egg-info/requires.txt

@@ -1,3 +1,5 @@
+pandas
+numpy
 
 [dev]
 build

{dynamic_characterization-0.0.1.dev1 → dynamic_characterization-0.0.2}/pyproject.toml

@@ -31,6 +31,8 @@ requires-python = ">=3.9"
 dependencies = [
     # dependencies as strings with quotes, e.g. "foo"
     # You can add version requirements like "foo>2.0"
+    "pandas",
+    "numpy",
 ]
 
 [project.urls]
@@ -60,7 +62,11 @@ dev = [
 [tool.setuptools]
 license-files = ["LICENSE"]
 include-package-data = true
-packages = ["dynamic_characterization"]
+packages = [
+    "dynamic_characterization", 
+    "dynamic_characterization.temporalis", 
+    "dynamic_characterization.timex",
+    ]
 
 [tool.setuptools.dynamic]
 version = {attr = "dynamic_characterization.__version__"}