maintenance of preprocessing module (#219)

* cleaning

* update of gcm preprocessing API

* update of gcm preprocessing API

* fix imports

* update docs

* update docs

* update era5 template path

Author: larsbuntemeyer

docs/api.rst

@@ -66,41 +66,14 @@ Pressure interpolation
 REMO preprocessor
 =================
 
-CMIP (CF) preprocessor
-----------------------
-
 .. autosummary::
    :toctree: generated/
 
-   preproc.gfile
+   preproc.get_gcm_dataset
+   preproc.get_gcm_gfile
    preproc.remap
-   preproc.to_netcdf
-   preproc.to_tar
-
-Double nesting preprocessor
----------------------------
-
-.. autosummary::
-   :toctree: generated/
-
    preproc.remap_remo
-
-
-ECMWF cmorizer (ERA5)
----------------------
-
-.. autosummary::
-   :toctree: generated/
-
    preproc.ERA5
-
-
-Converting ECMWF data
-^^^^^^^^^^^^^^^^^^^^^
-
-.. autosummary::
-   :toctree: generated/
-
    preproc.ERA5.gfile
 
 

docs/whats_new.rst

@@ -11,12 +11,23 @@ What's New
 UNRELEASED
 ----------
 
+This release introduces a new API for the preprocessing module and better documentation. The function
+:py:meth:`pyremo.preproc.gfile` is deprecated in favour on the new API in :py:meth:`pyremo.preproc.get_gcm_dataset`.
+Furthermore, :py:meth:`pyremo.preproc.get_gfile` is deprecated and :py:meth:`pyremo.preproc.get_gcm_gfile` should be used instead.
+
 Internal Changes
 ~~~~~~~~~~~~~~~~
 
+- New functions :py:meth:`pyremo.preproc.get_gcm_dataset` and :py:meth:`pyremo.preproc.get_gfile` are introduced for handling CMIP and ERA5 preprocessing (:pull:`219`).
 - Updates for ``cdo > 2.1`` (:pull:`217`).
 - Removed ``nblink`` dependency (:pull:`196`).
 
+Deprecations
+~~~~~~~~~~~~
+
+-  :py:meth:`pyremo.preproc.gfile` and :py:meth:`pyremo.preproc.get_gfile` are deprecated.
+
+
 v0.7.1 (2 August 2024)
 ----------------------
 

pyremo/preproc/__init__.py

@@ -1,6 +1,6 @@
 # flake8: noqa
 
-from .cf import get_gfile, gfile, to_cfdatetime
+from .cf import get_gcm_gfile, get_gcm_dataset, to_cfdatetime, gfile, get_gfile
 
 # from .core import gfile
 from .era5 import ERA5