Merge pull request #1040 from PCMDI/405_sic_ao

Update Sea Ice param file comments

doc/jupyter/Demo/sea_ice_param.py

@@ -1,5 +1,7 @@
 # Sea ice metrics parameter file
 
+# Settings for models
+# --------------------
 # List of models to include in analysis
 test_data_set = [
  "E3SM-1-0",
@@ -39,14 +41,32 @@
 metrics_output_path = "sea_ice_demo/%(case_id)/"
 
 # Settings for the observational data
+# ------------------------------------
+# Paths to northern and southern hemisphere files
 reference_data_path_nh = "/p/user_pub/pmp/demo/sea-ice/EUMETSAT/OSI-SAF-450-a-3-0/v20231201/ice_conc_nh_ease2-250_cdr-v3p0_198801-202012.nc"
 reference_data_path_sh = "/p/user_pub/pmp/demo/sea-ice/EUMETSAT/OSI-SAF-450-a-3-0/v20231201/ice_conc_sh_ease2-250_cdr-v3p0_198801-202012.nc"
+
+# Factor for adjusting obs data to decimal rather than percent units
 ObsUnitsAdjust = (True, "multiply", 1e-2)
+
+# Name of reference data
 reference_data_set = "OSI-SAF"
+
+# Start and end years for obs
 osyear = 1988
 oeyear = 2020
+
+# Name of sea ice concentration variable
 obs_var = "ice_conc"
+
+# Factor to convert area units to km-2
 ObsAreaUnitsAdjust = (False, 0, 0)
+
+# In this case there is no obs area file, so these are None
 obs_area_template = None
 obs_area_var = None
+
+# Because there is no obs area file and this data
+# uses an equal-area grid, we provide the
+# fixed grid cell area value in km2 units
 obs_cell_area = 625 # km 2