Update: support of ESA SCOPE PP parameter files

Author: heptaflar

INSTALL.md

@@ -81,4 +81,5 @@ The `pytest` output will be printed to the console and will read like, e.g.:
     test/kaleidoscope/test_generators.py .                                 [ 42%]
     test/kaleidoscope/test_reader.py ....                                  [ 71%]
     test/kaleidoscope/test_writer.py ....                                  [100%]
-    ======================= 14 passed in 152.59s (0:02:32) =======================
+
+    ======================= 14 passed in 145.04s (0:02:25) =======================

README.md

@@ -21,7 +21,7 @@ processor. The processor is invoked from the command line. Typing
 will print a detailed usage message to the screen
 
     usage: kaleidoscope [-h]
-                        --source-type {esa-cci-oc,esa-scope-exchange,ghrsst,glorys}
+                        --source-type {esa-cci-oc,esa-scope-cs,esa-scope-pp-parameters,ghrsst,glorys}
                         --selector SELECTOR
                         [--engine-reader {h5netcdf,netcdf4,zarr}]
                         [--engine-writer {h5netcdf,netcdf4,zarr}]
@@ -40,7 +40,7 @@ will print a detailed usage message to the screen
 
     options:
       -h, --help            show this help message and exit
-      --source-type {esa-cci-oc,esa-scope-exchange,ghrsst,glorys}
+      --source-type {esa-cci-oc,esa-scope-cs,esa-scope-pp-parameters,ghrsst,glorys}
                             the source type. (default: None)
       --selector SELECTOR   the Monte Carlo stream selector. An integral number
                             which must not be negative. (default: None)

kaleidoscope/config/config.random.json

@@ -162,7 +162,7 @@
       ]
     }
   },
-  "esa-scope-exchange": {
+  "esa-scope-cs": {
     "fco2": {
       "uncertainty": "fco2_tot_unc",
       "coverage": 2.0,
@@ -211,6 +211,28 @@
       ]
     }
   },
+  "esa-scope-pp-parameters": {
+      "rho": {
+        "uncertainty": 0.1,
+        "distribution": "lognormal"
+      },
+      "sigma": {
+        "uncertainty": 1.0,
+        "distribution": "lognormal"
+      },
+      "zm": {
+        "uncertainty": 1.0,
+        "distribution": "lognormal"
+      },
+      "alphaB": {
+        "uncertainty": 0.01,
+        "distribution": "lognormal"
+      },
+      "PmB": {
+        "uncertainty": 0.1,
+        "distribution": "normal"
+      }
+  },
   "ghrsst": {
     "analysed_sst": {
       "uncertainty": "analysed_sst_uncertainty",

kaleidoscope/config/config.reader.json

@@ -10,7 +10,7 @@
       "lat": 2160,
       "lon": 2160
     },
-    "esa-scope-exchange": {
+    "esa-scope-cs": {
       "time": 12,
       "latitude": 0,
       "longitude": 0

kaleidoscope/config/config.writer.json

@@ -10,7 +10,7 @@
       "lat": 270,
       "lon": 270
     },
-    "esa-scope-exchange": {
+    "esa-scope-cs": {
       "time": 12,
       "latitude": 0,
       "longitude": 0

kaleidoscope/parser.py

@@ -67,7 +67,13 @@ def _add_options(parser):
         parser.add_argument(
             "--source-type",
             help="the source type.",
-            choices=["esa-cci-oc", "esa-scope-exchange", "ghrsst", "glorys"],
+            choices=[
+                "esa-cci-oc",
+                "esa-scope-cs",
+                "esa-scope-pp-parameters",
+                "ghrsst",
+                "glorys",
+            ],
             required=True,
             dest="source_type",
         )

…doscope/templates/esa_scope_exchange.cdl kaleidoscope/templates/esa_scope_cs.cdlkaleidoscope/templates/esa_scope_exchange.cdl renamed to kaleidoscope/templates/esa_scope_cs.cdl kaleidoscope/templates/esa_scope_exchange.cdl renamed to kaleidoscope/templates/esa_scope_cs.cdl

@@ -0,0 +1,58 @@
+netcdf PE_mro_mean_prv_4km_120psummer_cor {
+dimensions:
+	lat = 4320 ;
+	lon = 8640 ;
+variables:
+	float latitude(lat) ;
+		latitude:_FillValue = -999.f ;
+		latitude:units = "degrees north" ;
+		latitude:_Storage = "contiguous" ;
+		latitude:_Endianness = "little" ;
+	float longitude(lon) ;
+		longitude:_FillValue = -999.f ;
+		longitude:units = "degrees east" ;
+		longitude:_Storage = "contiguous" ;
+		longitude:_Endianness = "little" ;
+	double sigma(lat, lon) ;
+		sigma:_FillValue = -999. ;
+		sigma:units = "mg m-3" ;
+		sigma:_Storage = "contiguous" ;
+		sigma:_Endianness = "little" ;
+	double zm(lat, lon) ;
+		zm:_FillValue = -999. ;
+		zm:units = "m" ;
+		zm:_Storage = "contiguous" ;
+		zm:_Endianness = "little" ;
+	double rho(lat, lon) ;
+		rho:_FillValue = -999. ;
+		rho:units = "dimensionless" ;
+		rho:_Storage = "contiguous" ;
+		rho:_Endianness = "little" ;
+	double alphaB(lat, lon) ;
+		alphaB:_FillValue = -999. ;
+		alphaB:units = "mgC mgChl-1 h-1 (W m-2)-1" ;
+		alphaB:_Storage = "contiguous" ;
+		alphaB:_Endianness = "little" ;
+	double PmB(lat, lon) ;
+		PmB:_FillValue = -999. ;
+		PmB:units = "mgC mgChl-1 h-1" ;
+		PmB:_Storage = "contiguous" ;
+		PmB:_Endianness = "little" ;
+	double lat(lat) ;
+		lat:_FillValue = NaN ;
+		lat:_Storage = "contiguous" ;
+		lat:_Endianness = "little" ;
+	double lon(lon) ;
+		lon:_FillValue = NaN ;
+		lon:_Storage = "contiguous" ;
+		lon:_Endianness = "little" ;
+
+// global attributes:
+		:description = "Physio_parameters_summer" ;
+		:source = "netCDF3 python" ;
+		:history = "Created Thu Jul  4 09:46:47 2024" ;
+		:_NCProperties = "version=2,netcdf=4.9.2,hdf5=1.14.3" ;
+		:_SuperblockVersion = 2 ;
+		:_IsNetcdf4 = 1 ;
+		:_Format = "netCDF-4" ;
+}

kaleidoscope/templates/esa_scope_pp_parameters.cdl

@@ -70,9 +70,9 @@ def test_read_esa_cci_oc(self):
         """Tests writing a generated target dataset."""
         self.assert_read("esa-cci-oc")
 
-    def test_read_esa_scope_exchange(self):
+    def test_read_esa_scope_cs(self):
         """Tests writing a generated target dataset."""
-        self.assert_read("esa-scope-exchange")
+        self.assert_read("esa-scope-cs")
 
     def test_read_ghrsst(self):
         """Tests writing a generated target dataset."""

test/kaleidoscope/test_reader.py

@@ -63,9 +63,9 @@ def test_write_esa_cci_oc(self):
         """Tests writing a generated target dataset."""
         self.assert_write("esa-cci-oc")
 
-    def test_write_esa_scope_exchange(self):
+    def test_write_esa_scope_cs(self):
         """Tests writing a generated target dataset."""
-        self.assert_write("esa-scope-exchange")
+        self.assert_write("esa-scope-cs")
 
     def test_write_ghrsst(self):
         """Tests writing a generated target dataset."""