fixed missing netCDF4 import; fixed 'cannot pickle' on adjust_3d functions; adjusted filenames in examples and readme;

Author: btschwertfeger

README.md

@@ -64,9 +64,9 @@ import xarray as xr
 from cmethods.CMethods import CMethods
 cm = CMethods()
 
-obsh = xr.open_dataset('input_data/obs.nc')
-simh = xr.open_dataset('input_data/contr.nc')
-simp = xr.open_dataset('input_data/scen.nc')
+obsh = xr.open_dataset('input_data/observations.nc')
+simh = xr.open_dataset('input_data/control.nc')
+simp = xr.open_dataset('input_data/scenario.nc')
 
 ls_result = cm.linear_scaling(
     obs = obsh['tas'][:,0,0],
@@ -102,14 +102,14 @@ Notes:
 `/examples/do_bias_correction.py`: Example script for adjusting climate data
 
 ```bash
-python3 do_bias_correction.py   \
-    --obs input_data/obs.nc     \
-    --contr input_data/contr.nc \
-    --scen input_data/scen.nc   \
-    --method linear_scaling     \
-    --variable tas              \
-    --unit '°C'                 \
-    --group time.month          \
+python3 do_bias_correction.py         \
+    --obs input_data/observations.nc  \
+    --contr input_data/control.nc     \
+    --scen input_data/scenario.nc     \
+    --method linear_scaling           \
+    --variable tas                    \
+    --unit '°C'                       \
+    --group time.month                \
     --kind +
 ```
 
@@ -119,11 +119,15 @@ python3 do_bias_correction.py   \
 
 ---
 
-## Notes:
+## Notes
 
 - Computation in Python takes some time, so this is only for demonstration. When adjusting large datasets, its best to the C++ implementation mentioned above.
 - Formulas and references can be found in the implementations of the corresponding functions.
 
+## Space for improvements
+
+Since the scaling methods implemented so far scale by default over the mean values of the respective months, unrealistic long-term mean values may occur at the month transitions. This can be prevented either by selecting `group='time.dayofyear`. Alternatively, it is possible not to scale using long-term mean values, but using a 30-day interval, which takes the 30 surrounding values over all years as the basis for calculating the mean values. This is not yet implemented in this module, but is available in the C++ implementation [here](https://github.com/btschwertfeger/Bias-Adjustment-Cpp).
+
 ## References
 
 - Schwertfeger, Benjamin Thomas (2022) The influence of bias corrections on variability, distribution, and correlation of temperatures in comparison to observed and modeled climate data in Europe (https://epic.awi.de/id/eprint/56689/)

cmethods/CMethods.py

@@ -124,13 +124,13 @@ def adjust_3d(cls,
             )
         '''
 
-        obs = obs.transpose('lat', 'lon', 'time')
-        simh = simh.transpose('lat', 'lon', 'time')
-        simp = simp.transpose('lat', 'lon', 'time')
+        obs = obs.transpose('lat', 'lon', 'time')#.load()
+        simh = simh.transpose('lat', 'lon', 'time')#.load()
+        simp = simp.transpose('lat', 'lon', 'time').load()
 
         if group == None and method in cls.SCALING_METHODS: group = 'time.month'
-
-        result = simp.copy(deep=True).load()
+        
+        result = simp.copy(deep=True)
         len_lat, len_lon = len(obs.lat), len(obs.lon)
 
         if method in cls.CUSTOM_METHODS:

cmethods/__version__.py

@@ -1,2 +1,2 @@
-VERSION = (0,5,4)
+VERSION = (0,5,4,1)
 __version__ = '.'.join(map(str, VERSION))

cmethods/requirements.txt

@@ -1,3 +1,4 @@
 numpy
 xarray
-tqdm
+tqdm
+netCDF4

setup.py

@@ -17,7 +17,7 @@
 
 # What packages are required for this module to be executed?
 REQUIRED = [
-   'xarray', 'numpy', 'tqdm' # <- always conflicts on install with tqdm
+   'xarray', 'numpy', 'tqdm', 'netCDF4' # <- always conflicts on install with tqdm on test.pypi..
 ]
 
 # What packages are optional?
@@ -118,11 +118,11 @@ def run(self):
     install_requires=REQUIRED,
     extras_require=EXTRAS,
     include_package_data=True,
-    license='MIT',
+    license='GPLv3',
     classifiers=[
         # Trove classifiers
         # Full list: https://pypi.python.org/pypi?%3Aaction=list_classifiers
-        'License :: OSI Approved :: MIT License',
+        'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
         'Programming Language :: Python',
         'Programming Language :: Python :: 3.7',
     ],