Test [DO NOT MERGE]

.circleci/config.yml

@@ -197,7 +197,7 @@ workflows:
               matrix:
                  parameters:
                     os: [ linux ]
-                    python_version: [ "3.8", "3.9", "3.10", "3.11", "3.12" ]
+                    python_version: [ "3.10" ]
               name: build-<< matrix.os >>-<< matrix.python_version >>
 
          - upload:

.github/workflows/nightly-build.yml

@@ -28,7 +28,7 @@ jobs:
             C_COMPILER: clang_osx-64 
             FORTRAN_COMPILER: gfortran_osx-64
             PROJECT_DIR: workdir/macos_64
-        python_version: ['3.8', '3.9', '3.10', '3.11', '3.12']
+        python_version: ['3.10']
     runs-on: ${{ matrix.runner.RUNNER_OS }}
     env:
       PACKAGE_NAME: cmor

Lib/__init__.py

@@ -11,8 +11,9 @@
     close, grid, set_grid_mapping, time_varying_grid_coordinate, dataset_json,
     set_cur_dataset_attribute, get_cur_dataset_attribute,
     has_cur_dataset_attribute, set_variable_attribute, get_variable_attribute,
-    has_variable_attribute, get_final_filename, set_deflate, set_furtherinfourl, 
-    set_climatology, get_climatology, set_terminate_signal, get_terminate_signal)
+    has_variable_attribute, get_final_filename, set_deflate, set_zstandard,
+    set_quantize, set_furtherinfourl, set_climatology, get_climatology,
+    set_terminate_signal, get_terminate_signal)
 
 try:
     from check_CMOR_compliant import checkCMOR

Lib/pywrapper.py

@@ -1032,6 +1032,41 @@ def set_deflate(var_id, shuffle, deflate, deflate_level):
     return _cmor.set_deflate(var_id, shuffle, deflate, deflate_level)
 
 
+def set_zstandard(var_id, zstandar_level):
+    """Sets Zstandard compression on a cmor variable
+    Usage:
+      cmor.set_zstandard(var_id, szstandar_level)
+    Where:
+      var_id: is cmor variable id
+      zstandar_level: Compression level. Must be set from -131072 to 22
+
+    """
+
+    return _cmor.set_zstandard(var_id, zstandar_level)
+
+
+def set_quantize(var_id, quantize_mode, quantize_nsd):
+    """Sets quantization on a cmor variable
+    Usage:
+      cmor.set_quantize(var_id, quantize_mode, quantize_nsd)
+    Where:
+      var_id: is cmor variable id
+      quantize_mode: Quantization mode.  Can be set to the following.
+                     0: No quantization mode
+                     1: BitGroom
+                     2: Granular BitRound
+                     3: BitRound
+      quantize_nsd: Number of significant digits.  If quantize_mode is set to
+                    1 or 2, then the value can be set from 1 to 7 for floats
+                    and 1 to 23 for doubles. If quantize_mode is set to 3, then
+                    the value can be set from 1 to 15 for floats and 1 to 52
+                    for doubles.  The value is ignore if quantize_mode is 0.
+
+    """
+
+    return _cmor.set_quantize(var_id, quantize_mode, quantize_nsd)
+
+
 def has_variable_attribute(var_id, name):
     """determines if the a cmor variable has an attribute
     Usage:

Makefile.in

@@ -225,6 +225,7 @@ test_python: python
 	env TEST_NAME=Test/test_cmor_python_not_enough_times_written.py make test_a_python
 	env TEST_NAME=Test/test_python_forecast_coordinates.py make test_a_python
 	env TEST_NAME=Test/test_cmor_CMIP6Plus.py make test_a_python
+	env TEST_NAME=Test/test_cmor_zstandard_and_quantize.py make test_a_python
 test_cmip6_cv: python
 	env TEST_NAME=Test/test_python_CMIP6_CV_sub_experimentnotset.py make test_a_python
 	env TEST_NAME=Test/test_python_CMIP6_CV_sub_experimentbad.py make test_a_python

Src/_cmormodule.c

@@ -151,6 +151,52 @@ static PyObject *PyCMOR_set_deflate(PyObject * self, PyObject * args)
     return (Py_BuildValue("i", ierr));
 }
 
+/************************************************************************/
+/*                   PyCMOR_set_zstandard()                    */
+/************************************************************************/
+static PyObject *PyCMOR_set_zstandard(PyObject * self, PyObject * args)
+{
+    signal(signal_to_catch, signal_handler);
+    int ierr, var_id, zstandard_level;
+
+    if (!PyArg_ParseTuple
+        (args, "ii", &var_id, &zstandard_level))
+        return NULL;
+
+    ierr = cmor_set_zstandard(var_id, zstandard_level);
+
+    if (ierr != 0 || raise_exception) {
+        raise_exception = 0;
+        PyErr_Format(CMORError, exception_message, "set_zstandard");
+        return NULL;
+    }
+
+    return (Py_BuildValue("i", ierr));
+}
+
+/************************************************************************/
+/*                   PyCMOR_set_quantize()                    */
+/************************************************************************/
+static PyObject *PyCMOR_set_quantize(PyObject * self, PyObject * args)
+{
+    signal(signal_to_catch, signal_handler);
+    int ierr, var_id, quantize_mode, quantize_nsd;
+
+    if (!PyArg_ParseTuple
+        (args, "iii", &var_id, &quantize_mode, &quantize_nsd))
+        return NULL;
+
+    ierr = cmor_set_quantize(var_id, quantize_mode, quantize_nsd);
+
+    if (ierr != 0 || raise_exception) {
+        raise_exception = 0;
+        PyErr_Format(CMORError, exception_message, "set_quantize");
+        return NULL;
+    }
+
+    return (Py_BuildValue("i", ierr));
+}
+
 /************************************************************************/
 /*                   PyCMOR_set_variable_attribute()                    */
 /************************************************************************/
@@ -1146,6 +1192,8 @@ static PyMethodDef MyExtractMethods[] = {
     {"set_furtherinfourl", PyCMOR_set_furtherinfourl, METH_VARARGS},
     {"get_final_filename", PyCMOR_getFinalFilename, METH_VARARGS},
     {"set_deflate", PyCMOR_set_deflate, METH_VARARGS},
+    {"set_zstandard", PyCMOR_set_zstandard, METH_VARARGS},
+    {"set_quantize", PyCMOR_set_quantize, METH_VARARGS},
     {"set_terminate_signal", PyCMOR_set_terminate_signal, METH_VARARGS},
     {"get_terminate_signal", PyCMOR_get_terminate_signal, METH_VARARGS},
     {NULL, NULL}                /*sentinel */

Src/cmor_cfortran_interface.c

@@ -92,6 +92,23 @@ int cmor_set_deflate_cff_(int *var_id, int *shuffle,
     return (cmor_set_deflate(*var_id, *shuffle, *deflate, *deflate_level));
 }
 
+/************************************************************************/
+/*                       cmor_set_zstandard_cff_()                        */
+/************************************************************************/
+int cmor_set_zstandard_cff_(int *var_id, int *zstandard_level)
+{
+    return (cmor_set_zstandard(*var_id, *zstandard_level));
+}
+
+/************************************************************************/
+/*                       cmor_set_quantize_cff_()                        */
+/************************************************************************/
+int cmor_set_quantize_cff_(int *var_id, int *quantize_mode,
+                          int *quantize_level)
+{
+    return (cmor_set_quantize(*var_id, *quantize_mode, *quantize_level));
+}
+
 /************************************************************************/
 /*                  cmor_get_variable_attribute_cff_()                  */
 /************************************************************************/

Src/cmor_fortran_interface.f90

@@ -85,6 +85,25 @@ function cmor_set_deflate_cff(var_id, shuffle, deflate, deflate_level )result (i
      end function cmor_set_deflate_cff
   end interface
 
+  interface
+     function cmor_set_zstandard_cff(var_id, zstandard_level )result (ierr)
+
+       integer, intent(in) :: var_id
+       integer, intent(in) :: zstandard_level
+       integer :: ierr
+     end function cmor_set_zstandard_cff
+  end interface
+
+  interface
+     function cmor_set_quantize_cff(var_id, quantize_mode, quantize_nsd )result (ierr)
+
+       integer, intent(in) :: var_id
+       integer, intent(in) :: quantize_mode
+       integer, intent(in) :: quantize_nsd
+       integer :: ierr
+     end function cmor_set_quantize_cff
+  end interface
+
   interface 
      function cmor_setup_cff_nolog(path,ncmode,verbosity,mode,crsub) result (j)
        integer ncmode,verbosity,mode, j, crsub
@@ -7168,6 +7187,24 @@ function cmor_set_deflate(var_id, shuffle, deflate, deflate_level) result (ierr)
     integer ierr
     ierr = cmor_set_deflate_cff(var_id, shuffle, deflate, deflate_level)
   end function cmor_set_deflate
+
+  function cmor_set_zstandard(var_id, zstandard_level) result (ierr)
+    implicit none
+    integer, intent (in) :: var_id
+    integer, intent (in) :: zstandard_level
+    integer ierr
+    ierr = cmor_set_zstandard_cff(var_id, zstandard_level)
+  end function cmor_set_zstandard
+
+  function cmor_set_quantize(var_id, quantize_mode, quantize_nsd) result (ierr)
+    implicit none
+    integer, intent (in) :: var_id
+    integer, intent (in) :: quantize_mode
+    integer, intent (in) :: quantize_nsd
+    integer ierr
+    ierr = cmor_set_quantize_cff(var_id, quantize_mode, quantize_nsd)
+  end function cmor_set_quantize
+
   function cmor_setup_ints(inpath,netcdf_file_action, set_verbosity,&
        exit_control, logfile, create_subdirectories) result(ierr)
     implicit none

Src/cmor_variables.c

@@ -2279,6 +2279,54 @@ int cmor_set_deflate(int var_id, int shuffle, int deflate, int deflate_level)
     return (0);
 }
 
+/************************************************************************/
+/*                       cmor_set_zstandard()                           */
+/************************************************************************/
+int cmor_set_zstandard(int var_id, int zstandard_level)
+{
+    char msg[CMOR_MAX_STRING];
+
+    cmor_add_traceback("cmor_set_zstandard");
+    cmor_is_setup();
+
+    if (cmor_vars[var_id].self != var_id) {
+        snprintf(msg, CMOR_MAX_STRING,
+                 "You attempted to set the zstandard level of "
+                 "variable id(%d) which was not initialized", var_id);
+        cmor_handle_error_var(msg, CMOR_CRITICAL, var_id);
+        cmor_pop_traceback();
+
+        return (-1);
+    }
+
+    cmor_pop_traceback();
+    return (0);
+}
+
+/************************************************************************/
+/*                       cmor_set_quantize()                            */
+/************************************************************************/
+int cmor_set_quantize(int var_id, int quantize_mode, int quantize_nsd)
+{
+    char msg[CMOR_MAX_STRING];
+
+    cmor_add_traceback("cmor_set_quantize");
+    cmor_is_setup();
+
+    if (cmor_vars[var_id].self != var_id) {
+        snprintf(msg, CMOR_MAX_STRING,
+                 "You attempted to set the quantize mode of "
+                 "variable id(%d) which was not initialized", var_id);
+        cmor_handle_error_var(msg, CMOR_CRITICAL, var_id);
+        cmor_pop_traceback();
+
+        return (-1);
+    }
+
+    cmor_pop_traceback();
+    return (0);
+}
+
 /************************************************************************/
 /*                   cmor_get_variable_time_length()                    */
 /************************************************************************/