Release Notes

Please note that as long as \(\omega radlib\) releases are within the 0.y.z series, the API cannot be considered stable. We will try to avoid sudden API breaks via deprecation warnings. All \(\omega radlib\) releases come without any warranty. Release notes might be incomplete. See here for a complete record of changes.

You can install the latest \(\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 Getting Started.

Bleeding Edge

Nothing, so far

Version 0.11.0

Highlights

  • Reorganize modules io and georef.
  • Add IRIS-Reader to io module.

New features

  • Enhanced: report code coverage on a per test-basis (unit, doc, notebook)
  • Enhanced: select tests per substring - argument with testrunner.py

Bugfixes

  • Fix latex functions in notebooks
  • Fix NaNs are considered adequately in weighted composition
  • Several minor fixes in codebase and docs

Version 0.10.1

Highlights

  • Introduced execute-workflow. Notebooks are now tested and rendered in one pass.
  • Meet GDAL RFC46.

New features

  • Enhanced wradlib.io.parse_DWD_quant_composite_header to handle QN-header.

Bugfixes

  • Fix wradlib.zonalstats.numpy_to_ogr to handle nested ndarrays
  • Fix several functions for use with numpy 1.13

Version 0.10.0

Highlights

New features

  • New notebook examples covering wradlib-tour, classification
  • Added reading WX-format to RADOLAN reader
  • Enhanced wradlib.io.read_RADOLAN_composite to also accept file-handles
  • Enhanced wradlib.io.read_Rainbow to also accept file-handles
  • Added reading groups to wradlib.io.read_generic_netcdf
  • Added wradlib.qual.cum_beam_block_frac to compute cumulative beam blockage
  • Added earth curvature display to beam blockage
  • Enhance wradlib.georef.read_gdal_values to read multiband data

Bugfixes

Deprecated features

  • wradlib.io.to_AAIGrid and wradlib.georef.to_GeoTIFF. Use wradlib.io.write_raster_dataset.
  • wradlib.io.read_raster_dataset
  • wradlib.georef.resample_raster_dataset. Use wradlib.georef.reproject_raster_dataset.

Version 0.9.0

Highlights

  • examples and tutorials are provided as jupyter notebooks
  • docs are directly created from notebooks (see full workflow here)
  • structured notebooks with parent notebook, where appropriate
  • documentation reviewed and adapted
    • community.rst,
    • dev_setup.rst,
    • gettingstarted.rst,
    • index.rst,
    • notebooks.rst,
    • release_notes.rst
  • docstrings reviewed, added links to notebooks where appropriate, cosmetic changes
  • package notebooks and converted python scripts with pypi-sdist
  • added tutorials on how to use notebooks and a breif Python introduction

New features

  • deploy untagged MICRO-version changes to test-pypi
  • reworked citation handling
  • added reading capability of new radolan FZ product
  • added use of dedicated wradlib-repo, WRADLIB_DATA env variable and data file retrieving functions
  • add ability to read gzipped dx data
  • enhanced wradlib.io.read_Rainbow to read product pixmap data from rainbow5 files

Bugfixes

  • removed bug reading lists in wradlib.io.read_Rainbow
  • fixed offset bug in wradlib.georef.sweep_centroids
  • fixed incompatibility issue of ipol module with scipy 0.18.0
  • several minor fixes

Version 0.8.0

Highlights

  • As of now \(\omega radlib\) is python3 compatible.
  • Docstrings, tests and examples as well as the documentation have been reviewed and fixed.
  • main \(\omega radlib\) repository is now hosted here on github.
  • \(\omega radlib\) docs are now hosted on github, but with custom domain.

New features

\(\omega radlib\) is constantly tested on travis-ci wradlib within a miniconda python environment with the latest python27, python34 and python35 interpreters on linux OS. We also check code coverage for all pull requests and additions with coveralls.

Deprecated features

None.

Removed functions

  • georef.create_projstr, also removed deprecated decorators

Version 0.7.0

Highlights

New experimental module zonalstats: it supports computation of zonal statistics (so far mean and variance) for target polygons. Typical applications would be the computation of average catchment rainfall from polar or cartesian grids. Check out the module documentation and the new examples.

Version 0.6.0

Highlights

\(\omega radlib\) functions concerned with georeferencing will only use projection information based on OSR objects. This version will help you to adapt your code base to this change before next minor release: Using deprecated PROJ.4 strings in call to the following functions/classes: vis.plot_ppi, vis.plot_ppi_crosshair, georef.projected_bincoords_from_radarspec, verify.PolarNeighbours, vpr.volcoords_from_polar, vpr.volcoords_from_polar_irregular, vpr.make_3D_grid will generate a DeprecationWarning and try to correct old calling method at runtime.

Added ability to handle georeferenced raster and vector data

Port of PyRadarMet partial beamblockage calculations by DEM

New features

  • In georef module a new helper function create_osr is added. This function helps to create an osr object for specific projections.
  • Bugfix: add multiplication of grid resolution in wradlib.georef.get_radolan_grid merged from v0.5.1
  • Several convenience functions for reading, transforming and projecting as well as plotting rasterfiles and shapefiles including example
  • Calculation of partial/cumulative beamblockage with example
  • The behaviour of wradlib.adjust.AdjustMFB has been changed. Control parameters are no longer passed via the __call__ function, but, as for all other adjustment classes, via the initialisation of an adjustment object. Documentation has been revised to make the behaviour more transparent. The parameter ‘biasby’ has been replaced by a dictionary mfb_args that carries all parameters that control the behaviour of AdjustMFB.

Deprecated features

Function georef.create_projstr is deprecated.

Removed functions

None.

Version 0.5.1

Highlights

Bugfix: add multiplication of grid resolution in wradlib.georef.get_radolan_grid merged from v0.4.2

Version 0.5.0

Highlights

From version 0.6.0 on, \(\omega radlib\) functions concerned with georeferencing will only use projection information based on OSR objects. This version will help you to adapt your code base to this change before using version 0.6.0: Any use of proj4 strings will generate a deprecation warning with the following functions/classes: vis.plot_ppi,``vis.plot_ppi_crosshair``, georef.projected_bincoords_from_radarspec, verify.PolarNeighbours, vpr.volcoords_from_polar, vpr.volcoords_from_polar_irregular, vpr.make_3D_grid.

New features

  • Two functions exposed documentation library section: generated/wradlib.io.read_safnwc and wradlib.vis.plot_max_plan_and_vert
  • New features, changes and deprecations will be addressed in the documentation in the future. This is by highlighting them as New in Version X.Y.Z, Changed in Version X.Y.Z or Deprecated since Version X.Y.Z

Deprecated features

None.

Removed functions

None.

Version 0.4.2

Highlights

Bugfix: add multiplication of grid resolution in wradlib.georef.get_radolan_grid

Version 0.4.1

Highlights

From now on, \(\omega radlib\) will generate warnings if keyword parameters of \(\omega radlib\) functions will be or have been changed. This is achieved by using wradlib.util.apichange_kwargs as a decorator (see apichange_example.py for examples how these warnings might look like). Please take these warnings seriously and adapt your applications before stepping to a new \(\omega radlib\) release.

Version 0.4.0

Highlights

  • Fixed a broken proj4 string for DWD radolan polarstereographic projection in function wradlib.georef.create_projstr
  • Added RADOLAN tutorial to the documentation. Together with that came new function to retrieve the RADOLAN composite grid.
  • Adding section Release notes to the documentation.

New features

Deprecated features

None.

Removed functions

None.

Version 0.3.0

Highlights

Visually most strikingly, we moved to a new style in our online documentation.

However, the most important change introduced with this release was to remove a number of deprecated functions that will not be supported anymore (see list below). Users who want to use these functions need to fall back to 0.2.0 (not recommended). Accordingly, examples and documentation has been revised in order to remove all remaining usage of deprecated functions and also fix some documentation issues.

In addition, we removed three outdated tutorial (on clutter detection, convertion and rainfall accumulation) and replaced the two latter by a more concise tutorial “Converting reflectivity to rainfall”.

Finally, we use one “central” bibliography for literature cross-referencing now (see http://wradlib.org/wradlib-docs/latest/zreferences.html).

New features

Deprecated features

None

Removed functions

The following functions/classes that were marked as deprecated before have been removed with this release:

  • wradlib.dp.fill_phidp
  • wradlib.dp.process_raw_phidp
  • wradlib.georef.polar2latlon
  • wradlib.georef.__pol2latlon
  • wradlib.georef.polar2latlonalt
  • wradlib.georef.polar2latlonalt_n
  • wradlib.georef.project
  • wradlib.vis.PolarPlot
  • wradlib.vis.polar_plot2
  • wradlib.vis.polar_plot
  • wradlib.vis.CartesianPlot
  • wradlib.vis.cartesian_plot
  • wradlib.vis.get_tick_vector
  • wradlib.vis.create_curvilinear_axes
  • wradlib.vis.rhi_plot
  • wradlib.vis.cg_plot
  • wradlib.vis.rhi_plot

Version 0.2.0

0.2.0 is the first new release of \(\omega radlib\) after more than three years of 0.0.1. The changes that have accumulated during this time are too many to list them here. Let’s just say that from here on, we will keep track of changes in \(\omega radlib\) releases more thoroughly.

Version 0.1.1

0.1.1 was the first experimental \(\omega radlib\) release.