cloudnetpy 1.55.20__py3-none-any.whl → 1.55.22__py3-none-any.whl

cloudnetpy/model_evaluation/statistics/statistical_methods.py

@@ -15,6 +15,7 @@ class DayStatistics:
     and observation data of wanted product.
 
     Args:
+    ----
         method (str): Name on statistical method to be calculated
         product_info (list): List of information of statistical analysis is
             done with. A list includes observed product name (str), model variable (str)
@@ -24,12 +25,15 @@ class DayStatistics:
         observation (np.ndarray): Ndrray of Downsampled observation of product
 
     Raises:
+    ------
         RuntimeError: A function of given method not found
 
     Returns:
+    -------
         day_statistic (object): The :class:'DayStatistic' object.
 
     Examples:
+    --------
         >>> from cloudnetpy.model_evaluation.products.product_resampling import \
         process_L3_day_product
         >>> method = 'error'
@@ -72,20 +76,22 @@ class DayStatistics:
             full_name = "vertical_profile"
         return full_name, params
 
-    def _generate_day_statistics(self):
+    def _generate_day_statistics(self) -> None:
         full_name, params = self._get_method_attr()
         cls = __import__("statistical_methods")
         try:
             self.model_stat, self.observation_stat = getattr(cls, f"{full_name}")(
-                *params
+                *params,
             )
-            self.title = getattr(cls, "day_stat_title")(self.method, self.product)
-        except RuntimeError as error:
-            logging.error(f"Method {full_name} not found or missing: {error}")
+            self.title = cls.day_stat_title(self.method, self.product)
+        except RuntimeError:
+            msg = f"Failed to calculate {self.method} of {self.product[0]}"
+            logging.exception(msg)
 
 
 def relative_error(
-    model: ma.MaskedArray, observation: ma.MaskedArray
+    model: ma.MaskedArray,
+    observation: ma.MaskedArray,
 ) -> tuple[float, str]:
     model, observation = combine_masked_indices(model, observation)
     error = ((model - observation) / observation) * 100
@@ -93,7 +99,8 @@ def relative_error(
 
 
 def absolute_error(
-    model: ma.MaskedArray, observation: ma.MaskedArray
+    model: ma.MaskedArray,
+    observation: ma.MaskedArray,
 ) -> tuple[float, str]:
     model, observation = combine_masked_indices(model, observation)
     error = (observation - model) * 100
@@ -101,7 +108,8 @@ def absolute_error(
 
 
 def combine_masked_indices(
-    model: ma.MaskedArray, observation: ma.MaskedArray
+    model: ma.MaskedArray,
+    observation: ma.MaskedArray,
 ) -> tuple[ma.MaskedArray, ma.MaskedArray]:
     """Connects two array masked indices to one and add in two array same mask"""
     observation[np.where(np.isnan(observation))] = ma.masked
@@ -113,9 +121,10 @@ def combine_masked_indices(
 
 
 def calc_common_area_sum(
-    model: ma.MaskedArray, observation: ma.MaskedArray
+    model: ma.MaskedArray,
+    observation: ma.MaskedArray,
 ) -> tuple[float, str]:
-    def _indices_of_mask_sum():
+    def _indices_of_mask_sum() -> float:
         # Calculate percentage value of common area of indices from two arrays.
         # Results is total number of common indices with value
         observation[np.where(np.isnan(observation))] = ma.masked
@@ -131,17 +140,21 @@ def calc_common_area_sum(
 
 
 def histogram(
-    product: list, model: ma.MaskedArray, observation: ma.MaskedArray
+    product: list,
+    model: ma.MaskedArray,
+    observation: ma.MaskedArray,
 ) -> tuple:
     if "cf" in product:
         model = ma.round(model[~model.mask].data, decimals=1).flatten()
         observation = ma.round(
-            observation[~observation.mask].data, decimals=1
+            observation[~observation.mask].data,
+            decimals=1,
         ).flatten()
     else:
-        model = ma.round(model[~model.mask].data, decimals=6).flatten()
-        observation = ma.round(
-            observation[~observation.mask].data, decimals=6
+        model = np.round(model[~model.mask].data, decimals=6).flatten()
+        observation = np.round(
+            observation[~observation.mask].data,
+            decimals=6,
         ).flatten()
     observation = observation[~np.isnan(observation)]
     hist_bins = np.histogram(observation, density=True)[-1]

cloudnetpy/model_evaluation/tests/e2e/conftest.py

@@ -3,11 +3,11 @@ import pytest
 args = ["site", "date", "input", "output", "full_path"]
 
 
-def pytest_addoption(parser):
+def pytest_addoption(parser) -> None:
     for arg in args:
         parser.addoption(f"--{arg}", action="store")
 
 
-@pytest.fixture
-def params(request):
+@pytest.fixture()
+def params(request) -> dict:
     return {arg: request.config.getoption(f"--{arg}") for arg in args}

cloudnetpy/model_evaluation/tests/e2e/process_cf/main.py

@@ -15,11 +15,15 @@ test_file_model = (
 test_file_product = f"{ROOT_PATH}/cloudnetpy/model_evaluation/tests/data/20190517_mace-head_categorize.nc"
 
 
-def _process():
+def _process() -> None:
     tmp_dir = TemporaryDirectory()
     temp_file = f"{tmp_dir.name}/xx.nc"
     product_resampling.process_L3_day_product(
-        "ecmwf", "cf", [test_file_model], test_file_product, temp_file
+        "ecmwf",
+        "cf",
+        [test_file_model],
+        test_file_product,
+        temp_file,
     )
     try:
         subprocess.call(
@@ -29,20 +33,20 @@ def _process():
                 f"{SCRIPT_PATH}/tests.py",
                 "--full_path",
                 temp_file,
-            ]
+            ],
         )
     except subprocess.CalledProcessError:
         raise
     tmp_dir.cleanup()
 
 
-def main():
+def main() -> None:
     _process()
 
 
 if __name__ == "__main__":
     parser = argparse.ArgumentParser(
-        description="Model evaluation Cloud fraction processing e2e test."
+        description="Model evaluation Cloud fraction processing e2e test.",
     )
     ARGS = parser.parse_args()
     main()

cloudnetpy/model_evaluation/tests/e2e/process_cf/tests.py

@@ -6,11 +6,11 @@ class TestCloudFractionProcessing:
     product = "cf"
 
     @pytest.fixture(autouse=True)
-    def _fetch_params(self, params):
+    def _fetch_params(self, params) -> None:
         self.full_path = params["full_path"]
 
-    @pytest.mark.reprocess
-    def test_that_has_correct_attributes(self):
+    @pytest.mark.reprocess()
+    def test_that_has_correct_attributes(self) -> None:
         nc = netCDF4.Dataset(self.full_path)
         assert nc.location == "Mace-Head"
         assert nc.year == "2019"
@@ -25,31 +25,32 @@ class TestCloudFractionProcessing:
         )
         nc.close()
 
-    @pytest.mark.reprocess
+    @pytest.mark.reprocess()
     @pytest.mark.parametrize(
-        "key", ["cf_V_ecmwf", "cf_A_ecmwf", "cf_V_adv_ecmwf", "cf_A_adv_ecmwf"]
+        "key",
+        ["cf_V_ecmwf", "cf_A_ecmwf", "cf_V_adv_ecmwf", "cf_A_adv_ecmwf"],
     )
-    def test_that_has_correct_product_variables(self, key):
+    def test_that_has_correct_product_variables(self, key) -> None:
         nc = netCDF4.Dataset(self.full_path)
-        assert key in nc.variables.keys()
+        assert key in nc.variables
         nc.close()
 
-    @pytest.mark.reprocess
+    @pytest.mark.reprocess()
     @pytest.mark.parametrize(
         "key",
         ["time", "level", "latitude", "longitude", "horizontal_resolution"],
     )
-    def test_that_has_correct_model_variables(self, key):
+    def test_that_has_correct_model_variables(self, key) -> None:
         nc = netCDF4.Dataset(self.full_path)
-        assert key in nc.variables.keys()
+        assert key in nc.variables
         nc.close()
 
-    @pytest.mark.reprocess
+    @pytest.mark.reprocess()
     @pytest.mark.parametrize(
         "key",
         ["ecmwf_forecast_time", "ecmwf_height", "ecmwf_cf", "ecmwf_cf_cirrus"],
     )
-    def test_that_has_correct_cycle_variables(self, key):
+    def test_that_has_correct_cycle_variables(self, key) -> None:
         nc = netCDF4.Dataset(self.full_path)
-        assert key in nc.variables.keys()
+        assert key in nc.variables
         nc.close()

cloudnetpy/model_evaluation/tests/e2e/process_iwc/main.py

@@ -19,11 +19,15 @@ test_file_model = (
 test_file_product = f"{ROOT_PATH}/cloudnetpy/model_evaluation/tests/data/20190517_mace-head_iwc-Z-T-method.nc"
 
 
-def _process():
+def _process() -> None:
     tmp_dir = TemporaryDirectory()
     temp_file = f"{tmp_dir.name}/xx.nc"
     product_resampling.process_L3_day_product(
-        "ecmwf", "iwc", [test_file_model], test_file_product, temp_file
+        "ecmwf",
+        "iwc",
+        [test_file_model],
+        test_file_product,
+        temp_file,
     )
     try:
         subprocess.call(
@@ -33,20 +37,20 @@ def _process():
                 f"{SCRIPT_PATH}/tests.py",
                 "--full_path",
                 temp_file,
-            ]
+            ],
         )
     except subprocess.CalledProcessError:
         raise
     tmp_dir.cleanup()
 
 
-def main():
+def main() -> None:
     _process()
 
 
 if __name__ == "__main__":
     parser = argparse.ArgumentParser(
-        description="Model evaluation Ice water content processing e2e test."
+        description="Model evaluation Ice water content processing e2e test.",
     )
     ARGS = parser.parse_args()
     main()

cloudnetpy/model_evaluation/tests/e2e/process_iwc/tests.py

@@ -6,11 +6,11 @@ class TestCloudFractionProcessing:
     product = "iwc"
 
     @pytest.fixture(autouse=True)
-    def _fetch_params(self, params):
+    def _fetch_params(self, params) -> None:
         self.full_path = params["full_path"]
 
-    @pytest.mark.reprocess
-    def test_that_has_correct_attributes(self):
+    @pytest.mark.reprocess()
+    def test_that_has_correct_attributes(self) -> None:
         nc = netCDF4.Dataset(self.full_path)
         assert nc.location == "Mace-Head"
         assert nc.year == "2019"
@@ -25,7 +25,7 @@ class TestCloudFractionProcessing:
         )
         nc.close()
 
-    @pytest.mark.reprocess
+    @pytest.mark.reprocess()
     @pytest.mark.parametrize(
         "key",
         [
@@ -37,26 +37,27 @@ class TestCloudFractionProcessing:
             "iwc_rain_adv_ecmwf",
         ],
     )
-    def test_that_has_correct_product_variables(self, key):
+    def test_that_has_correct_product_variables(self, key) -> None:
         nc = netCDF4.Dataset(self.full_path)
-        assert key in nc.variables.keys()
+        assert key in nc.variables
         nc.close()
 
-    @pytest.mark.reprocess
+    @pytest.mark.reprocess()
     @pytest.mark.parametrize(
         "key",
         ["time", "level", "latitude", "longitude", "horizontal_resolution"],
     )
-    def test_that_has_correct_model_variables(self, key):
+    def test_that_has_correct_model_variables(self, key) -> None:
         nc = netCDF4.Dataset(self.full_path)
-        assert key in nc.variables.keys()
+        assert key in nc.variables
         nc.close()
 
-    @pytest.mark.reprocess
+    @pytest.mark.reprocess()
     @pytest.mark.parametrize(
-        "key", ["ecmwf_forecast_time", "ecmwf_height", "ecmwf_iwc"]
+        "key",
+        ["ecmwf_forecast_time", "ecmwf_height", "ecmwf_iwc"],
     )
-    def test_that_has_correct_cycle_variables(self, key):
+    def test_that_has_correct_cycle_variables(self, key) -> None:
         nc = netCDF4.Dataset(self.full_path)
-        assert key in nc.variables.keys()
+        assert key in nc.variables
         nc.close()

cloudnetpy/model_evaluation/tests/e2e/process_lwc/main.py

@@ -15,11 +15,15 @@ test_file_model = (
 test_file_product = f"{ROOT_PATH}/cloudnetpy/model_evaluation/tests/data/20190517_mace-head_lwc-scaled-adiabatic.nc"
 
 
-def _process():
+def _process() -> None:
     tmp_dir = TemporaryDirectory()
     temp_file = f"{tmp_dir.name}/xx.nc"
     product_resampling.process_L3_day_product(
-        "ecmwf", "lwc", [test_file_model], test_file_product, temp_file
+        "ecmwf",
+        "lwc",
+        [test_file_model],
+        test_file_product,
+        temp_file,
     )
     try:
         subprocess.call(
@@ -29,20 +33,20 @@ def _process():
                 f"{SCRIPT_PATH}/tests.py",
                 "--full_path",
                 temp_file,
-            ]
+            ],
         )
     except subprocess.CalledProcessError:
         raise
     tmp_dir.cleanup()
 
 
-def main():
+def main() -> None:
     _process()
 
 
 if __name__ == "__main__":
     parser = argparse.ArgumentParser(
-        description="Model evaluation liquid water content processing e2e test."
+        description="Model evaluation liquid water content processing e2e test.",
     )
     ARGS = parser.parse_args()
     main()

cloudnetpy/model_evaluation/tests/e2e/process_lwc/tests.py

@@ -6,11 +6,11 @@ class TestCloudFractionProcessing:
     product = "lwc"
 
     @pytest.fixture(autouse=True)
-    def _fetch_params(self, params):
+    def _fetch_params(self, params) -> None:
         self.full_path = params["full_path"]
 
-    @pytest.mark.reprocess
-    def test_that_has_correct_attributes(self):
+    @pytest.mark.reprocess()
+    def test_that_has_correct_attributes(self) -> None:
         nc = netCDF4.Dataset(self.full_path)
         assert nc.location == "Mace-Head"
         assert nc.year == "2019"
@@ -25,28 +25,29 @@ class TestCloudFractionProcessing:
         )
         nc.close()
 
-    @pytest.mark.reprocess
+    @pytest.mark.reprocess()
     @pytest.mark.parametrize("key", ["lwc_ecmwf", "lwc_adv_ecmwf"])
-    def test_that_has_correct_product_variables(self, key):
+    def test_that_has_correct_product_variables(self, key) -> None:
         nc = netCDF4.Dataset(self.full_path)
-        assert key in nc.variables.keys()
+        assert key in nc.variables
         nc.close()
 
-    @pytest.mark.reprocess
+    @pytest.mark.reprocess()
     @pytest.mark.parametrize(
         "key",
         ["time", "level", "latitude", "longitude", "horizontal_resolution"],
     )
-    def test_that_has_correct_model_variables(self, key):
+    def test_that_has_correct_model_variables(self, key) -> None:
         nc = netCDF4.Dataset(self.full_path)
-        assert key in nc.variables.keys()
+        assert key in nc.variables
         nc.close()
 
-    @pytest.mark.reprocess
+    @pytest.mark.reprocess()
     @pytest.mark.parametrize(
-        "key", ["ecmwf_forecast_time", "ecmwf_height", "ecmwf_lwc"]
+        "key",
+        ["ecmwf_forecast_time", "ecmwf_height", "ecmwf_lwc"],
     )
-    def test_that_has_correct_cycle_variables(self, key):
+    def test_that_has_correct_cycle_variables(self, key) -> None:
         nc = netCDF4.Dataset(self.full_path)
-        assert key in nc.variables.keys()
+        assert key in nc.variables
         nc.close()

cloudnetpy/model_evaluation/tests/unit/conftest.py

@@ -6,7 +6,7 @@ import pytest
 
 
 @pytest.fixture(scope="session")
-def file_metadata():
+def file_metadata() -> dict:
     year, month, day = "2019", "05", "23"
     return {
         "year": year,
@@ -19,7 +19,7 @@ def file_metadata():
 
 
 @pytest.fixture(scope="session")
-def model_file(tmpdir_factory, file_metadata):
+def model_file(tmpdir_factory, file_metadata) -> str:
     file_name = tmpdir_factory.mktemp("data").join("file.nc")
     root_grp = netCDF4.Dataset(file_name, "w", format="NETCDF4_CLASSIC")
     time = 3
@@ -61,7 +61,7 @@ def model_file(tmpdir_factory, file_metadata):
 
 
 @pytest.fixture(scope="session")
-def obs_file(tmpdir_factory, file_metadata):
+def obs_file(tmpdir_factory, file_metadata) -> str:
     file_name = tmpdir_factory.mktemp("data").join("file.nc")
     root_grp = netCDF4.Dataset(file_name, "w", format="NETCDF4_CLASSIC")
     time = 6
@@ -96,7 +96,7 @@ def obs_file(tmpdir_factory, file_metadata):
             [4, 4, 0, 1],
             [0, 8, 16, 16],
             [32, 2, 8, 32],
-        ]
+        ],
     )
     var = root_grp.createVariable("quality_bits", "i4", ("time", "height"))
     var[:] = np.array(
@@ -107,7 +107,7 @@ def obs_file(tmpdir_factory, file_metadata):
             [0, 1, 2, 4],
             [8, 16, 32, 16],
             [8, 4, 2, 1],
-        ]
+        ],
     )
     var = root_grp.createVariable("iwc", "f8", ("time", "height"))
     var[:] = np.array(
@@ -118,7 +118,7 @@ def obs_file(tmpdir_factory, file_metadata):
             [0.01, 0.02, 0.06, 0.01],
             [0.02, 0.06, 0.00, 0.03],
             [0.08, 0.00, 0.03, 0.08],
-        ]
+        ],
     )
     var = root_grp.createVariable("iwc_retrieval_status", "f8", ("time", "height"))
     var[:] = np.array(
@@ -129,7 +129,7 @@ def obs_file(tmpdir_factory, file_metadata):
             [1, 2, 6, 7],
             [4, 6, 5, 3],
             [7, 5, 3, 4],
-        ]
+        ],
     )
     var = root_grp.createVariable("lwc", "f8", ("time", "height"))
     var[:] = np.array(
@@ -140,7 +140,7 @@ def obs_file(tmpdir_factory, file_metadata):
             [0.08, 0.04, 0.01, 0.08],
             [0.04, 0.01, 0.09, 0.07],
             [0.02, 0.09, 0.07, 0.02],
-        ]
+        ],
     )
     var = root_grp.createVariable("data", "i4", ("time", "height"))
     var[:] = np.array(
@@ -151,14 +151,14 @@ def obs_file(tmpdir_factory, file_metadata):
             [3, 5, 1, 0],
             [2, 5, 6, 1],
             [2, 9, 7, 2],
-        ]
+        ],
     )
     root_grp.close()
     return file_name
 
 
 @pytest.fixture(scope="session")
-def regrid_file(tmpdir_factory, file_metadata):
+def regrid_file(tmpdir_factory, file_metadata) -> str:
     file_name = tmpdir_factory.mktemp("data").join("file.nc")
     root_grp = netCDF4.Dataset(file_name, "w", format="NETCDF4_CLASSIC")
     time = 3
@@ -198,6 +198,6 @@ def regrid_file(tmpdir_factory, file_metadata):
     return file_name
 
 
-def _create_global_attributes(root_grp, meta):
+def _create_global_attributes(root_grp, meta) -> None:
     for key in ("year", "month", "day", "location"):
         setattr(root_grp, key, meta[key])