MNT: update docs for release 1.19 (#21)

Author: kmuehlbauer

source/community.rst

@@ -6,9 +6,9 @@ Users
 
 :math:`\omega radlib` is intended to be a community effort, and community needs communication.
 
-The key communication platform for :math:`\omega radlib` is the  `wradlib-users <https://groups.google.com/forum/?fromgroups=#!forum/wradlib-users>`_ mailing list and forum. Through this forum, you can help to improve :math:`\omega radlib` by reporting bugs, proposing enhancements, or by contributing code snippets (in any programming language) and documentation of algorithms.
+The key communication platform for :math:`\omega radlib` is beside the `wradlib GitHub repo <https://github.com/wradlib/wradlib>`_ the `openradar-discourse <https://openradar.discourse.group/>`_ discussion forum. Through both ways, you can help to improve :math:`\omega radlib` by reporting bugs, proposing enhancements, or by contributing code snippets (in any programming language) and documentation of algorithms.
 
-You can also ask other users and developers for help, or use your own knowledge and experience to help other users. We strongly encourage you to `subscribe <https://groups.google.com/forum/#!forum/wradlib-users/join>`_ to this list. Check it out!
+You can also ask other users and developers for help, or use your own knowledge and experience to help other users. We strongly encourage you to subscribe to `openradar-discourse <https://openradar.discourse.group/>`_. Check it out!
 
 How to contribute to :math:`\omega radlib`?
 -------------------------------------------

source/conf.py

@@ -41,8 +41,8 @@
               ]
 
 extlinks = {
-    "issue": ("https://github.com/wradlib/wradlib/issues/%s", "GH"),
-    "pull": ("https://github.com/wradlib/wradlib/pull/%s", "PR"),
+    "issue": ("https://github.com/wradlib/wradlib/issues/%s", "GH%s"),
+    "pull": ("https://github.com/wradlib/wradlib/pull/%s", "PR%s"),
 }
 
 mathjax_path = ("https://cdn.mathjax.org/mathjax/latest/MathJax.js?"
@@ -113,7 +113,7 @@
                               shell=True)
 
     # install wradlib target branch/tag
-    subprocess.check_call(['pip', 'install', '--no-deps', '--upgrade',
+    subprocess.check_call(['python', '-m', 'pip', 'install', '--no-deps', '--upgrade',
                            "git+{0}/wradlib.git@{1}"
                            "".format(url, wradlib_branch_or_tag)])
 
@@ -260,14 +260,14 @@ def __getattr__(cls, name):
 html_show_copyright = True
 
 intersphinx_mapping = {
-    'python': ('https://docs.python.org/3/', None),
-    'numpy': ('https://numpy.org/doc/stable/', None),
-    'scipy': ('https://docs.scipy.org/doc/scipy/objects.inv', None),
-    'matplotlib': ('https://matplotlib.org/stable/', None),
-    'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
-    'xarray': ('https://docs.xarray.dev/en/stable/objects.inv', None),
-    'cartopy': ('https://scitools.org.uk/cartopy/docs/latest/', None),
-    'gdal': ('https://gdal.org/python/', "objects_gdal.inv")
+    'python': ('https://docs.python.org/3', None),
+    'numpy': ('https://numpy.org/doc/stable', None),
+    'scipy': ('https://docs.scipy.org/doc/scipy', None),
+    'matplotlib': ('https://matplotlib.org/stable', None),
+    'sphinx': ('https://www.sphinx-doc.org/en/master', None),
+    'xarray': ('https://docs.xarray.dev/en/stable', None),
+    'cartopy': ('https://scitools.org.uk/cartopy/docs/latest', None),
+    'gdal': ('https://gdal.org/python', "objects_gdal.inv")
 }
 
 # -- Napoleon settings for docstring processing -------------------------------

source/dev_guide.rst

@@ -3,7 +3,7 @@ Developer Guide
 
 Setup
 -----
-The section :doc:`installation` will provide you with detailed guidance on how to install :math:`\omega radlib` and the required dependencies for different operating systems (MS Windows, Linux, Mac OS). :math:`\omega radlib` |release| has been tested with the latest Anaconda Python on linux-64. It is available via `conda-forge` channel on linux-64, osx-64 and MS Windows 64 versions.
+The section :doc:`installation` will provide you with detailed guidance on how to install :math:`\omega radlib` and the required dependencies for different operating systems (MS Windows, Linux, Mac OS). :math:`\omega radlib` |release| has been tested with the latest conda-forge Python on linux-64. It is available via `conda-forge` channel on linux-64, osx-64 and MS Windows 64 versions.
 
 As a developer, though, you should rather link into :math:`\omega radlib`'s version control. This way, it will be easier for you to track changes and to contribute your changes to :math:`\omega radlib`'s main respository (see next section). Just install `Git <https://git-scm.com/>`_, then clone the :math:`\omega radlib` repository to your local system by executing the following command in your shell: ``git clone https://github.com/wradlib/wradlib.git``. Do not forget to set the ``PYTHONPATH`` to point to the corresponding directory.
 
@@ -38,4 +38,6 @@ Testing
 
 Continuous Integration
 ----------------------
-We use Github Actions for Continuous Integration (CI). CI means, in our case, that each commit pushed to :math:`\omega radlib`'s main repository will trigger different test suites on the CI service. If all tests pass successfully, a new documentation will be built on https://readthedocs.org and published on https://docs.wradlib.org. In case a new release tag is associated with a commit, a new release will be distributed via `PyPI <https://pypi.org/project/wradlib/>`_.
+We use Github Actions for Continuous Integration (CI). CI means, in our case, that each commit pushed to :math:`\omega radlib`'s main repository as well as within each Pull request will trigger different test suites on the CI service. If all tests pass successfully, a new documentation will be built on https://readthedocs.org and published on https://docs.wradlib.org. In case a new release tag is associated with a commit, a new release will be distributed via `PyPI <https://pypi.org/project/wradlib/>`_.
+
+

source/ide.rst

@@ -12,7 +12,7 @@ Some suitable IDEs
 
 There is a `comprehensive Wiki article on Python IDEs <https://wiki.python.org/moin/IntegratedDevelopmentEnvironments>`_. Maybe a bit too comprehensive... if you already are used to an IDE and happy with it, there is no reason to change it.
 
-However, if you have no idea which IDE to choose, why not start with `Spyder <https://www.spyder-ide.org/>`_? It is included in the `Anaconda Python Distribution <https://www.anaconda.com/products/individual>`_ by default. If you installed Anaconda, just open a shell (Anaconda Prompt on Windows) and enter::
+However, if you have no idea which IDE to choose, why not start with `Spyder <https://www.spyder-ide.org/>`_? It is included in the `Anaconda Python Distribution <https://www.anaconda.com/products/individual>`_ by default. Or just install it in any conda-environment. Then all you have to do is open a shell and enter::
 
     $ spyder
 

source/index.rst

@@ -11,6 +11,11 @@ wradlib: An Open Source Library for Weather Radar Data Processing
 :notebooks: |notebooks-link|
 :docs: |docs-link|
 
+.. note::
+
+   :math:`\omega radlib` version line 1.19 is the last version before :math:`\omega radlib` v2.0. Please pay attention to deprecations and update your code accordingly.
+
+
 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.
 
 .. note::
@@ -36,7 +41,6 @@ Documentation
 
 * :doc:`installation`
 * :doc:`docker`
-* :doc:`ide`
 
 .. toctree::
    :maxdepth: 1

source/installation.rst

@@ -8,9 +8,9 @@ Anaconda/Conda
 
 In order to run :math:`\omega radlib`, you need to have a Python interpreter installed on your local computer, as well as a number of Python packages (`Dependencies`_). We recommend installing `Anaconda <https://www.anaconda.com/products/individual>`_ as it includes Python, numerous required packages, and other useful tools (e.g. `Spyder <https://www.spyder-ide.org/>`_).
 
-Using Anaconda the installation process is harmonised across platforms. Download and install the latest `Anaconda distribution <https://www.anaconda.com/products/individual>`_ for your specific OS. We recommend using the minimal `Miniconda <https://conda.io/miniconda.html>`_ if you do not want to install a full scientific python stack.
+Using Anaconda the installation process is harmonised across platforms. Download and install the latest `Anaconda distribution <https://www.anaconda.com/products/individual>`_ for your specific OS. We recommend using the minimal `Miniforge or Mambaforge <https://github.com/conda-forge/miniforge>`_ if you do not want to install a full scientific python stack (see `Mambaforge`_).
 
-We are constantly performing tests with these distributions (for the most recent 3 python versions).
+We are constantly performing tests with `conda-forge <https://conda-forge.org/>`_ community channel (for the most recent 3 python versions).
 
 If your Anaconda Python installation is working, the following command (in a console) should work::
 
@@ -29,7 +29,7 @@ Now you can use the ``conda`` package and environment manager (`conda documentat
 
 #. Create a new environment from scratch::
 
-    $ conda create --name wradlib python=3.8
+    $ conda create --name wradlib python=3.11
 
 #. Activate the :math:`\omega radlib` environment::
 
@@ -41,18 +41,25 @@ Now you can use the ``conda`` package and environment manager (`conda documentat
 
 Now you have a ``conda`` environment with a working :math:`\omega radlib` installation.
 
+Mambaforge
+----------
+
+This is our recommended method. The install procedure is essentially the same as with Anaconda/Miniconda but it will utilize the fast drop-in replacement `mamba <https://mamba.readthedocs.io/>`_. Please refer to their documentation.
+
+Testdrive
+---------
+
 Test the integrity of your :math:`\omega radlib` installation by opening a console window and typing calling the python interpreter::
 
     $ python
-    Python 3.7.8 | packaged by conda-forge | (default, Jul 31 2020, 02:25:08)
-    [GCC 7.5.0] on linux
+    Python 3.11.0 | packaged by conda-forge | (main, Jan 14 2023, 12:27:40) [GCC 11.3.0] on linux
     Type "help", "copyright", "credits" or "license" for more information.
 
 The Python prompt should appear. Then type::
 
     >>> import wradlib
     >>> wradlib.__version__
-    '1.8.0'
+    '1.19.0'
 
 If everything is ok, this will show the running :math:`\omega radlib` version. If the :math:`\omega radlib` package is not found by the interpreter, you will get::
 
@@ -116,6 +123,8 @@ Dependencies
 +------------+-----------+-------------+
 | xarray     | >= 0.17   | >= 0.20.2   |
 +------------+-----------+-------------+
+| xradar     | >=0.0.13  | >= 0.0.13   |
++------------+-----------+-------------+
 
 You can check whether the required `Dependencies`_ are available on your computer by opening a Python console and enter:
 
@@ -144,6 +153,8 @@ As for now, the following dependencies are defined as optional:
 +------------+-----------+-------------+
 | Package    |    min    | recommended |
 +============+===========+=============+
+| cartopy    | >= 0.21   | >= latest   |
++------------+-----------+-------------+
 | dask       | >= 2.20   | >= latest   |
 +------------+-----------+-------------+
 | gdal       | >= 2.4    | >= 3.1.0    |
@@ -159,13 +170,12 @@ As for now, the following dependencies are defined as optional:
 | xmltodict  | >= 0.11   | >= 0.12.0   |
 +------------+-----------+-------------+
 
-
 The following libraries are used by `netCDF4`, `h5py`/`h5netcdf` and `gdal` packages and should apply to these requirements:
 
-.. tabularcolumns:: |L|L|L|L
+.. tabularcolumns:: |L|L|L|L|
 
 +------------+-----------+-------------+---------+
-| Library     |    min    | recommended | used by |
+| Library    |    min    | recommended | used by |
 +============+===========+=============+=========+
 | geos       | >= 3.7.0  | >= 3.10.0   | gdal    |
 +------------+-----------+-------------+---------+
@@ -195,6 +205,6 @@ Depending on your OS and installation method you may encounter different problem
 
 We strongly recommend using the Anaconda conda package and environment manager (see `Installation`_). Using `conda-forge <https://conda-forge.org/>`_ we will maintain the `wradlib-feedstock <https://github.com/conda-forge/wradlib-feedstock/>`_ for constant availability of recent :math:`\omega radlib` versions.
 
-If you can't use Anaconda/Miniconda, it is generally a good idea to use your systems package manager to install dependencies. This will also take account for other needed bindings, libs etc.
+If you can't use Anaconda/Miniconda/Mambforge, it is generally a good idea to use your systems package manager to install dependencies. This will also take account for other needed bindings, libs etc.
 
-If you encounter problems installing :math:`\omega radlib`, check on your favorite search engine or create an issue `here <https://github.com/wradlib/wradlib/issues>`_ with details on the problem or send an email on the `wradlib-users <https://groups.google.com/forum/?fromgroups=#!forum/wradlib-users>`_ mailing list.
+If you encounter problems installing :math:`\omega radlib`, check on your favorite search engine or create an issue `at the wradlib issue tracker <https://github.com/wradlib/wradlib/issues>`_ with details on the problem or check with the `openradar-discourse <https://openradar.discourse.group/>`_.

source/jupyter.rst

@@ -12,7 +12,7 @@ Interactive examples with jupyter notebooks
 
 All :math:`\omega radlib` examples are distributed as `jupyter notebooks <https://jupyter.org/>`_ in the `wradlib-notebooks <https://github.com/wradlib/wradlib-notebooks/>`_ repository. This way, you can interactively explore various topics. Each notebook is organized in documented code blocks. You can browse through a notebook block by block, inspect the results, and experiment with the code. However, you can also view the rendered notebooks including the example results on the web pages of this section: Each page was directly generated from :math:`\omega radlib`'s example notebooks. This way, you can copy&paste code snippets directly into your applications.
 
-.. note:: Are you using :math:`\omega radlib` on the `Open Virtual Machine for Cross-Platform Weather Radar Science <https://openradarscience.org/>`_? Then skip the rest: just log in, run the command ``$ ./start_notebook.sh`` and direct your browser to `http://127.0.0.1:8888/tree <http://127.0.0.1:8888/tree>`__. That's it.
+.. note:: Are you using :math:`\omega radlib` with the `Open Radar Science Shortcourse <https://openradarscience.org/erad2022/>`_? Then please follow-up there to get your openradar software stack running.
 
 Otherwise, you need to make sure to
 

source/release_notes.rst

@@ -3,9 +3,31 @@
 Release Notes
 =============
 
-Please note that :math:`\omega radlib` releases follow `semantic versioning <https://semver.org/>`_. API breaks will be announced via deprecation warnings. All :math:`\omega radlib` releases come without any warranty. Release notes might be incomplete. See `here <https://github.com/wradlib/wradlib/commits/main>`_ for a complete record of changes.
+Please note that :math:`\omega radlib` releases follow `semantic versioning <https://semver.org/>`_. API breaks will be announced via deprecation warnings. All :math:`\omega radlib` releases come without any warranty. Release notes might be incomplete. See `the commits <https://github.com/wradlib/wradlib/commits/main>`_ for a complete record of changes.
 
-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`.
+You can install the latest :math:`\omega radlib` release from PyPI via ``$ python -m pip install wradlib`` or specific version via ``$ python -m pip install wradlib==x.y.z``. The recommended installation process is described in :doc:`installation`.
+
+Version 1.19.0
+--------------
+
+This version is most likely the last version before wradlib 2.0. We've switched to use `xradar <https://docs.openradarscience.org/projects/xradar>`_ for reading radar data in polar coordinates. The relevant code has been ported from wradlib to xradar and only a shallow compatibility layer is kept in wradlib.
+
+**New features**
+
+* Enhance Furuno Reader to read WR110 data (:pull:`606`) by `@kmuehlbauer <https://github.com/kmuehlbauer>`_
+* New function for cross sections (RHI) from radar volume (:issue:`439`) by `@pandasambit15 <https://github.com/pandasambit15>`_ and (:pull:`610`) by `@JulianGiles <https://github.com/JulianGiles>`_
+
+**Maintenance code**
+
+* Adapt codebase to use xradar, move/remove duplicate code (:pull:`617`) by `@kmuehlbauer <https://github.com/kmuehlbauer>`_
+
+**Maintenance - CI**
+
+* several updates and fixes to the CI (:pull:`604`), (:pull:`613`), (:pull:`616`), (:pull:`618`) by `@kmuehlbauer <https://github.com/kmuehlbauer>`_
+
+**Bugfixes**
+
+* delete tmp-files for VectorSource after closing (:issue:`608`) and (:pull:`609`) by `@plvoit <https://github.com/plvoit>`_
 
 Version 1.18.0
 --------------