Clean up

iiasa · Jan 10, 2025 · 1c8d1ec · 1c8d1ec
1 parent f98359f
commit 1c8d1ec
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 3 deletions.
diff --git a/notebooks/0104_GFED-BB4CMIP-postprocess.py b/notebooks/0104_GFED-BB4CMIP-postprocess.py
@@ -86,17 +86,17 @@
 # %%
 with pint.get_application_registry().context("NOx_conversions"):
     df_renamed_desired_units = pix.units.convert_unit(
-        df_renamed, 
+        df_renamed,
         {"Mt NO / yr": "Mt NO2/yr"},
     )
 
 # %%
 df_renamed_desired_units = pix.units.convert_unit(
-    df_renamed_desired_units, 
+    df_renamed_desired_units,
     lambda x: x.replace(" / yr", "/yr"),
 )
 df_renamed_desired_units = pix.units.convert_unit(
-    df_renamed_desired_units, 
+    df_renamed_desired_units,
     {"Mt N2O/yr": "kt N2O/yr"},
 )
 

diff --git a/src/emissions_harmonization_historical/units.py b/src/emissions_harmonization_historical/units.py
@@ -31,6 +31,19 @@
 
 
 def assert_units_match_wishes(indf: pd.DataFrame) -> None:
+    """
+    Assert that the units used in a `pd.DataFrame` match the units we want
+
+    Parameters
+    ----------
+    indf
+        `pd.DataFrame` to check
+
+    Raises
+    ------
+    AssertionError
+        Units for emissions of a species don't match the desired units
+    """
     mismatches = []
     for species, target_unit in UNIT_WISHES:
         locator = pix.ismatch(variable=f"**Emissions|{species}|**")