Merge pull request #190 from esowc/branch-alba

Rename component_mol_weight to component_MW

Author: albavilanova

functions/functions_cams.ipynb

@@ -662,21 +662,21 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "def CAMS_kg_m2_to_molecules_cm2(CAMS_ds, component_mol_weight):\n",
+    "def CAMS_kg_m2_to_molecules_cm2(CAMS_ds, component_MW):\n",
     "\n",
     "    \"\"\" Convert the units of the CAMS dataset for any component from kg/m2 to molecules/cm2\n",
     "\n",
     "        Args:\n",
     "            CAMS_ds (xarray): CAMS levels dataset in xarray format\n",
-    "            component_mol_weight (float): Component molecular weight\n",
+    "            component_MW (float): Component molecular weight\n",
     "\n",
     "        Returns:\n",
     "            CAMS_ds (xarray): CAMS levels dataset in xarray format\n",
     "    \"\"\"\n",
     "\n",
     "    # Convert units from kg/m2 to molecules/cm2\n",
     "    NA = 6.022*10**23\n",
-    "    CAMS_ds['component'] = (CAMS_ds['component'] * NA * 1000) / (10000 * component_mol_weight)\n",
+    "    CAMS_ds['component'] = (CAMS_ds['component'] * NA * 1000) / (10000 * component_MW)\n",
     "    \n",
     "    return CAMS_ds"
    ]

functions/functions_general.ipynb

@@ -99,7 +99,7 @@
     "\n",
     "        Returns:\n",
     "            component (str): Component name\n",
-    "            component_mol_weight (float): Component molecular weight\n",
+    "            component_MW (float): Component molecular weight\n",
     "            component_sensor_product (str): Component product name in TROPOMI, IASI or GOME-2 database\n",
     "            sensor_column (str): Component column name in TROPOMI, IASI or GOME-2 database\n",
     "            column_type (str): Tropospheric or total column\n",
@@ -111,8 +111,7 @@
     "\n",
     "    component_col = ['nitrogen_dioxide', 'carbon_monoxide', 'ozone', 'sulphur_dioxide', \n",
     "                     'methane', 'formaldehyde', 'ammonia']\n",
-    "    component_mol_weight_col = [46.005, 28.01, 48, 64.066, \n",
-    "                                16.04, 30.031, 17.031]\n",
+    "    component_MW_col = [46.005, 28.01, 48, 64.066, 16.04, 30.031, 17.031]\n",
     "    component_tropomi_L3_column_col = ['NO2trop', '-', '-', '-', '-', '-', '-']\n",
     "    component_tropomi_L2_column_col = ['nitrogendioxide_tropospheric_column', \n",
     "                                       'carbonmonoxide_total_column', \n",
@@ -130,7 +129,7 @@
     "    component_gome_L2_column_col = ['NO2trop', '-', 'O3total', 'SO2total', '-', 'HCHOtotal', '-']\n",
     "\n",
     "    rows = {'Nomenclature': component_nom_col, \n",
-    "            'Weight': component_mol_weight_col,\n",
+    "            'Weight': component_MW_col,\n",
     "            'Component': component_col, \n",
     "            'TROPOMI_L3_column': component_tropomi_L3_column_col,\n",
     "            'TROPOMI_L2_product': component_tropomi_L2_product_col,\n",
@@ -143,7 +142,7 @@
     "    components_table = pd.DataFrame(rows)\n",
     "\n",
     "    component = components_table['Component'].loc[components_table['Nomenclature'] == component_nom].iloc[0]\n",
-    "    component_mol_weight = components_table['Weight'].loc[components_table['Nomenclature'] == component_nom].iloc[0]\n",
+    "    component_MW = components_table['Weight'].loc[components_table['Nomenclature'] == component_nom].iloc[0]\n",
     "    \n",
     "    if sensor == 'tropomi' and sensor_type == 'L2':\n",
     "        sensor_product_type = components_table['TROPOMI_L2_product'].loc[components_table['Nomenclature'] == component_nom].iloc[0]\n",
@@ -156,7 +155,7 @@
     "    else:\n",
     "        column_type = 'total'\n",
     "\n",
-    "    return component, component_mol_weight, sensor_product_type, sensor_column, column_type"
+    "    return component, component_MW, sensor_product_type, sensor_column, column_type"
    ]
   },
   {
@@ -495,7 +494,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "def model_convert_units(model, model_ds, sensor, component_mol_weight, model_levels_df, \n",
+    "def model_convert_units(model, model_ds, sensor, component_MW, model_levels_df, \n",
     "                        start_date, end_date, component_nom, apply_kernels = False, \n",
     "                        CAMS_UID = None, CAMS_key = None):\n",
     "\n",
@@ -505,7 +504,7 @@
     "            model (str): Name of the model\n",
     "            model_ds (xarray): model dataset in xarray format (CAMS)\n",
     "            sensor (str): Name of the sensor\n",
-    "            component_mol_weight (float): Component molecular weight\n",
+    "            component_MW (float): Component molecular weight\n",
     "            model_levels_df (dataframe): Table with 137 CAMS levels data\n",
     "            start_date (str): Query start date\n",
     "            end_date (str): Query end date\n",
@@ -530,7 +529,7 @@
     "\n",
     "        if model_ds.component.units == 'kg m**-2':\n",
     "\n",
-    "            model_ds = CAMS_kg_m2_to_molecules_cm2(model_ds, component_mol_weight)\n",
+    "            model_ds = CAMS_kg_m2_to_molecules_cm2(model_ds, component_MW)\n",
     "            units = 'molec cm-2'\n",
     "            model_ds['component'] = model_ds.component.assign_attrs({'units': units})\n",
     "            print('The model component units have been converted from kg m**-2 to molec cm-2.')\n",

main_cams_gome_L2.ipynb

@@ -156,7 +156,7 @@
     "comparison_check(sensor, model, component_nom, model_full_name, sensor_type, apply_kernels)\n",
     "\n",
     "# Get component full name and molecular weight\n",
-    "component, component_mol_weight, product_type, sensor_column, column_type = components_table(sensor, component_nom, sensor_type)\n",
+    "component, component_MW, product_type, sensor_column, column_type = components_table(sensor, component_nom, sensor_type)\n",
     "\n",
     "# Folders generation\n",
     "generate_folders(model, sensor, component_nom, sensor_type)"
@@ -929,7 +929,7 @@
    ],
    "source": [
     "model_ds, units = model_convert_units(model, model_ds, sensor, \n",
-    "                                      component_mol_weight, model_levels_df,\n",
+    "                                      component_MW, model_levels_df,\n",
     "                                      start_date, end_date, component_nom, apply_kernels,\n",
     "                                      CAMS_UID = None, CAMS_key = None)"
    ]

main_cams_gome_L3.ipynb

@@ -161,7 +161,7 @@
     "comparison_check(sensor, model, component_nom, model_full_name, sensor_type, apply_kernels)\n",
     "\n",
     "# Get component full name and molecular weight\n",
-    "component, component_mol_weight, product_type, sensor_column, column_type = components_table(sensor, component_nom, sensor_type)\n",
+    "component, component_MW, product_type, sensor_column, column_type = components_table(sensor, component_nom, sensor_type)\n",
     "\n",
     "# Folders generation\n",
     "generate_folders(model, sensor, component_nom, sensor_type)"
@@ -710,7 +710,7 @@
    ],
    "source": [
     "model_ds, units = model_convert_units(model, model_ds, sensor, \n",
-    "                                      component_mol_weight, model_levels_df,\n",
+    "                                      component_MW, model_levels_df,\n",
     "                                      start_date, end_date, component_nom, apply_kernels,\n",
     "                                      CAMS_UID = None, CAMS_key = None)"
    ]