MNT: update for wradlib v1.12.0

Author: kmuehlbauer

LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2011-2020 wradlib developers
+Copyright (c) 2011-2021 wradlib developers
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

readthedocs_environment.yml

@@ -13,10 +13,4 @@ dependencies:
   - git
   - nbsphinx
   - semver
- # - scipy
- # - matplotlib
- # - h5py
- # - netCDF4
- # - gdal
-  - xmltodict
   - xarray

requirements.txt

@@ -5,6 +5,5 @@ sphinx_rtd_theme
 sphinxcontrib-bibtex
 deprecation
 nbsphinx
-xmltodict
 semver
 xarray

source/conf.py

@@ -132,19 +132,20 @@ def __getattr__(cls, name):
                 'scipy.interpolate', 'scipy.ndimage',
                 'scipy.ndimage.interpolation',
                 'scipy.ndimage.filters', 'scipy.signal',
-                'matplotlib', 'matplotlib.path', 'matplotlib.patches',
-                'matplotlib.pyplot', 'matplotlib.projections',
-                'matplotlib.transforms',
-                'matplotlib.ticker',
-                'matplotlib.dates',
-                'matplotlib.collections',
-                'mpl_toolkits',
-                'mpl_toolkits.axisartist',
-                'mpl_toolkits.axisartist.grid_finder',
-                'mpl_toolkits.axisartist.angle_helper',
-                'h5py', 'h5netcdf',
-                'netCDF4', 'osgeo',
-                'cartopy']
+                # 'matplotlib', 'matplotlib.path', 'matplotlib.patches',
+                # 'matplotlib.pyplot', 'matplotlib.projections',
+                # 'matplotlib.transforms',
+                # 'matplotlib.ticker',
+                # 'matplotlib.dates',
+                # 'matplotlib.collections',
+                # 'mpl_toolkits',
+                # 'mpl_toolkits.axisartist',
+                # 'mpl_toolkits.axisartist.grid_finder',
+                # 'mpl_toolkits.axisartist.angle_helper',
+                # 'h5py', 'h5netcdf',
+                # 'netCDF4', 'osgeo',
+                # 'cartopy',
+                ]
 sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
 
 # get wradlib version

source/index.rst

@@ -6,10 +6,10 @@
 wradlib: An Open Source Library for Weather Radar Data Processing
 =================================================================
 
-:Release: {release}
+:Release: `1.12.1 <https://github.com/wradlib/wradlib/tree/844edc381d6e46112b2db81c77956d8cbe6286a0>`_
 :Date: |today|
-:notebooks: {notebooks}
-:docs: {docs}
+:notebooks: Missing
+:docs: `a95490b <https://github.com/wradlib/wradlib-docs/tree/a95490bf80641fa8fc5d4b1d7fa7f73636abd828>`_
 
 The :math:`\omega radlib` project has been initiated in order facilitate the use of weather radar data as well as to provide a common platform for research on new algorithms. :math:`\omega radlib` is an open source library which is well documented and easy to use. It is written in the free programming language `Python <https://www.python.org>`_. As of version 1.3 :math:`\omega radlib` is Python 3 only.
 

source/installation.rst

@@ -69,7 +69,7 @@ Bleeding edge code
 
 `Download <https://codeload.github.com/wradlib/wradlib/zip/main>`_ the source, unzip, and run::
 
-    $ python setup.py install
+    $ python -m pip install .
 
 Alternatively, you can add the :math:`\omega radlib` directory to your environment variable ``PYTHONPATH``.
 
@@ -81,7 +81,7 @@ Although we recommend using the Anaconda Python Environment you can install :mat
 
 Open a terminal and run::
 
-    $ pip install wradlib
+    $ python -m pip install wradlib
 
 Depending on your system you might need to be root (or sudo the above command) for this to work.
 ``pip`` will then fetch the source distribution from the Python Package Index and run the installation.
@@ -93,36 +93,28 @@ For example the numpy module itself depends on some other libraries, which need
 
 Therefore we recommend trying to satisfy the dependencies using your favorite package management system.
 
+Installing via ``pip`` tries to install all dependencies, but be sure to have all depending non-python libraries installed. Wheels are not available for all dependencies (eg. GDAL).
+
 
 .. _ref-dependencies:
 
 Dependencies
 ------------
 
-:math:`\omega radlib` was not designed to be a self-contained library. Besides extensive use of Numpy and Scipy, :math:`\omega radlib` uses additional libraries, which you will need to install before you can use :math:`\omega radlib`.
+:math:`\omega radlib` was not designed to be a self-contained library. Besides extensive use of Numpy and Scipy, :math:`\omega radlib` uses additional libraries, which you might need to install before you can use :math:`\omega radlib` depending on your system and installation procedure.
 
 .. tabularcolumns:: |L|L|L|
 
 +------------+-----------+-------------+
 | Package    |    min    | recommended |
 +============+===========+=============+
-| numpy      | >= 1.9    | >= 1.19.0   |
-+------------+-----------+-------------+
-| matplotlib | >= 3      | >= 3.3.0    |
+| numpy      | >= 1.9    | >= 1.21.0   |
 +------------+-----------+-------------+
-| scipy      | >= 1.0    | >= 1.5.0    |
-+------------+-----------+-------------+
-| h5py       | >= 2.0.1  | >= 3.1.0    |
-+------------+-----------+-------------+
-| h5netcdf   | >= 0.8.0  | >= 0.10.0   |
-+------------+-----------+-------------+
-| netCDF4    | >= 1.0    | >= 1.5.0    |
+| scipy      | >= 1.0    | >= 1.7.0    |
 +------------+-----------+-------------+
-| xarray     | >= 0.15   | >= 0.17.0   |
-+------------+-----------+-------------+
-| xmltodict  | >= 0.11   | >= 0.12.0   |
+| matplotlib | >= 3      | >= 3.3.0    |
 +------------+-----------+-------------+
-| gdal       | >= 2.4    | >= 3.1.0    |
+| xarray     | >= 0.17   | >= 0.20.2   |
 +------------+-----------+-------------+
 
 You can check whether the required `Dependencies`_ are available on your computer by opening a Python console and enter:
@@ -139,29 +131,51 @@ some version number
 
 The version number should be consistent with the above `Dependencies`_.
 
-The following libraries are used by `netCDF4`, `h5py` and `gdal` packages and should apply to these requirements:
+
+Optional Dependencies
+---------------------
+
+Apart from the obligatory `Dependencies`_, some dependencies in :math:`\omega radlib` are optional. This is because the installation of these dependencies can be somewhat tedious while many :math:`\omega radlib` users will not need them anyway. In case users use a :math:`\omega radlib` function that requires an optional dependency, and this dependency is not satisfied in the local environment, :math:`\omega radlib` will raise an exception.
+
+As for now, the following dependencies are defined as optional:
 
 .. tabularcolumns:: |L|L|L|
 
 +------------+-----------+-------------+
-| Lbrary     |    min    | recommended |
+| Package    |    min    | recommended |
 +============+===========+=============+
-| geos       | >= 3.7.0  | >= 3.8.0    |
+| dask       | >= 2.20   | >= latest   |
 +------------+-----------+-------------+
-| hdf5       | >= 1.9.0  | >= 1.10.0   |
+| gdal       | >= 2.4    | >= 3.1.0    |
 +------------+-----------+-------------+
-| libnetcdf  | >= 4.7.3  | >= 4.7.4    |
+| h5py       | >= 2.0.1  | >= 3.1.0    |
++------------+-----------+-------------+
+| h5netcdf   | >= 0.8.0  | >= 0.10.0   |
 +------------+-----------+-------------+
-| proj4/proj | >= 5.2.0  | >= 7.0.0    |
+| netCDF4    | >= 1.0    | >= 1.5.0    |
++------------+-----------+-------------+
+| requests   | >= 2.23.0 | >= 2.26.0   |
++------------+-----------+-------------+
+| xmltodict  | >= 0.11   | >= 0.12.0   |
 +------------+-----------+-------------+
 
 
-Optional Dependencies
----------------------
+The following libraries are used by `netCDF4`, `h5py`/`h5netcdf` and `gdal` packages and should apply to these requirements:
 
-Apart from the obligatory `Dependencies`_, some dependencies in :math:`\omega radlib` are optional. This is because the installation of these dependencies can be somewhat tedious while many :math:`\omega radlib` users will not need them anyway. In case users use a :math:`\omega radlib` function that requires an optional dependency, and this dependency is not satisfied in the local environment, :math:`\omega radlib` will raise an exception.
+.. tabularcolumns:: |L|L|L|L
+
++------------+-----------+-------------+---------+
+| Library     |    min    | recommended | used by |
++============+===========+=============+=========+
+| geos       | >= 3.7.0  | >= 3.10.0   | gdal    |
++------------+-----------+-------------+---------+
+| hdf5       | >= 1.9.0  | >= 1.12.1   | h5py    |
++------------+-----------+-------------+---------+
+| libnetcdf  | >= 4.7.3  | >= 4.8.1    | netCDF4 |
++------------+-----------+-------------+---------+
+| proj       | >= 5.2.0  | >= 8.0.0    | gdal    |
++------------+-----------+-------------+---------+
 
-As for now, the following dependencies are defined as optional:
 
 **The speedup module**
 

source/release_notes.rst

@@ -7,6 +7,33 @@ Please note that :math:`\omega radlib` releases follow `semantic versioning <htt
 
 You can install the latest :math:`\omega radlib` release from PyPI via ``$ pip install wradlib`` or specific version via ``$ pip install wradlib==x.y.z``. The recommended installation process is described in :doc:`installation`.
 
+Version 1.12.0
+--------------
+
+**New features**
+
+* add IRIS/Sigmet backend for ``Xarray`` (:issue:`361`) (:pull:`520`) by `@kmuehlbauer <https://github.com/kmuehlbauer>`_
+* add Rainbow backend for ``Xarray`` (:issue:`394`, :issue:`459`) suggested by `@wcwoo <https://github.com/wcwoo>`_ and `@maxok <https://github.com/maxok>`_ (:pull:`522`) by `@kmuehlbauer <https://github.com/kmuehlbauer>`_
+
+**Maintenance**
+
+* optionalize dependencies (dask, gdal, h5netcdf, h5py, netCDF4, requests, xmltodict) (:pull:`531`) by `@kmuehlbauer <https://github.com/kmuehlbauer>`_
+* utilize pytest-doctestplus (:pull:`530`) by `@kmuehlbauer <https://github.com/kmuehlbauer>`_
+* update deprecated matplotlib functionality (:pull:`530`) by `@kmuehlbauer <https://github.com/kmuehlbauer>`_
+* docstring updates in several functions (:pull:`530`, ) by `@kmuehlbauer <https://github.com/kmuehlbauer>`_
+* docstring updates in several functions
+
+**Bugfixes**
+
+* use reasonable default values in `io.xarray.to_odim` (gain, offset, nodata, undetect, fillvalue)
+* add cf attributes when reading GAMIC files (:pull:`523`) by `@kmuehlbauer <https://github.com/kmuehlbauer>`_
+* fix regression in legacy GAMIC reader (:pull:`523`) by `@kmuehlbauer <https://github.com/kmuehlbauer>`_
+* catch `dt.accessor` TypeError (:pull:`529`)  by `@kmuehlbauer <https://github.com/kmuehlbauer>`_
+* fix thread-lock issue, if dask is not installed (:pull:`531`) by `@kmuehlbauer <https://github.com/kmuehlbauer>`_
+* use int instead np.int in radolan header parser (:pull:`531`) by `@kmuehlbauer <https://github.com/kmuehlbauer>`_
+* fix several tests (:pull:`531`) by `@kmuehlbauer <https://github.com/kmuehlbauer>`_
+* other minor fixes distributed over several PR's
+
 Version 1.11.0
 --------------