Skip to content

Commit

Permalink
Prepare v0.3.0 (#80)
Browse files Browse the repository at this point in the history
* Updated whatsnew

* minor update to README

* bump version to 0.3.0 in setup.py
  • Loading branch information
cchwala committed May 5, 2021
1 parent d546dd6 commit 4957a60
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 5 deletions.
4 changes: 2 additions & 2 deletions README.md
Expand Up @@ -9,7 +9,7 @@ A python toolbox for deriving rainfall information from commercial microwave lin
Installation
------------

`pycomlink` works with Python 2.7, Python 3.6 and Python 3.7. It can be installed via [`conda-forge`](https://conda-forge.org/):
`pycomlink` works with Python 3.6 and newer. It might still work with Python 2.7, but this is not tested. It can be installed via [`conda-forge`](https://conda-forge.org/):

$ conda install -c conda-forge pycomlink

Expand All @@ -19,7 +19,7 @@ Installation via `pip` is also possible:

$ pip install pycomlink

If you install via `pip`, there might be problems with some dependencies, though. Currently the dependency `pykrige` only installs if `scipy`, `numpy` and `matplotlib` have been installed before.
If you install via `pip`, there might be problems with some dependencies, though. E.g. the dependency `pykrige` may only install if `scipy`, `numpy` and `matplotlib` have been installed before.

To run the example notebooks you will also need the [Jupyter Notebook](https://jupyter.org/)
and `ipython`, both also available via `conda` or `pip`.
Expand Down
30 changes: 30 additions & 0 deletions docs/whats-new.rst
Expand Up @@ -2,6 +2,36 @@
What's New
**********************

v0.3.0
------

Backward Incompatible Changes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* The old API using `pycomlink.core.Comlink` objects has been removed. All processing
functions now work with `xarray.DataArrays` or pure `numpy.ndarray`. Most of the
original functions and notebooks from v0.2.x do not work anymore, but the basic parts
have already been refactored so that the full processing chain, from raw CML data
to rainfall fields works in v0.3.0.

Enhancements
~~~~~~~~~~~~

* Added new example notebook for basic processing workflow (by cchwala in PR #77)

* Added new example data (by maxmargraf in PR #75)

* started docs from scratch with working integration to readthedocs (by jpolz in PR #74)

* read data from cmlh5 files to `xarray.Dataset` (by maxmargraf in PR #68)

* Added functions to perform wet-dry classification with trained CNN (by jpolz in PR #67)

* applied black formatting to codebase (by nblettner in PR #66)

* make repo runnable via mybinder (by jpolz in PR #64)


v0.2.4
------

Expand Down
5 changes: 2 additions & 3 deletions setup.py
Expand Up @@ -17,23 +17,22 @@ def read(fname):

setup(
name = "pycomlink",
version = "0.3.0alpha",
version = "0.3.0",
author = "Christian Chwala",
author_email = "christian.chwala@kit.edu",
description = ("Python tools for MW link data processing"),
license = "BSD",
keywords = "microwave links precipitation radar",
url = "https://github.com/pycomlink/pycomlink",
download_url = (
"https://github.com/pycomlink/pycomlink/archive/0.2.4.tar.gz"),
"https://github.com/pycomlink/pycomlink/archive/0.3.0.tar.gz"),
packages=find_packages(exclude=['test']),
include_package_data=True,
long_description=read('README.md'),
classifiers=[
"Development Status :: 3 - Alpha",
"Topic :: Scientific/Engineering :: Atmospheric Science",
"License :: OSI Approved :: BSD License",
'Programming Language :: Python :: 2.7',
'Programming Language :: Python :: 3.6'
],
# A list of all available classifiers can be found at
Expand Down

0 comments on commit 4957a60

Please sign in to comment.