Release update (#43)

* update files for 1.0.0rc3 release * try2 to separate description from readme * update cancellation instructions * update release date and minor changes * add header to content in docs index * remove bulletpoints in readme * update zenodo creators * minor modification to Readme and docs * add line blocks to readme * remove dot in readme * update documentation * link to fixed bugs in changelog * Update CHANGELOG.rst * Update CHANGELOG.rst
eWaterCycle · Jul 15, 2019 · 321945d · 321945d
1 parent d923f62
commit 321945d
Show file tree

Hide file tree

Showing 13 changed files with 77 additions and 26 deletions.
diff --git a/.zenodo.json b/.zenodo.json
@@ -31,6 +31,10 @@
         {
             "affiliation": "Netherlands eScience Center",
             "name": "Weel, Berend"
+        },
+        {
+            "affiliation": "TU Delft",
+            "name": "Hut, Rolf"
         }
     ],
     "description": "  A command line interface to download ERA5 data from the Climate Data Store.",

diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,12 +1,19 @@
-Changelog
-*********
+Release Notes
+*************
+
+1.0.0rc3 (2019-07-15)
+~~~~~~~~~~~~~~~~~~~~~
+* Third Release Candidate for the stable 1.0.0 era5cli release.
+* Improve documentation `#21 <https://github.com/eWaterCycle/era5cli/issues/21>`_ `#29 <https://github.com/eWaterCycle/era5cli/issues/29>`_.
+* Cleanup command line options `#19 <https://github.com/eWaterCycle/era5cli/issues/19>`_ `#20 <https://github.com/eWaterCycle/era5cli/issues/20>`_.
+* Append era5cli version to history of downloaded netCDF file `#17 <https://github.com/eWaterCycle/era5cli/issues/17>`_.
 
 1.0.0rc2 (2019-07-01)
-=====================
+~~~~~~~~~~~~~~~~~~~~~
 * Second Release Candidate for the stable 1.0.0 era5cli release.
-* Fix downloading all variables when requesting multiple variables and using --split #23.
-* Fix link to Pypi package in documentation #22.
+* Fix downloading all variables when requesting multiple variables and using --split `#23 <https://github.com/eWaterCycle/era5cli/issues/23>`_.
+* Fix link to PyPI package in documentation `#22 <https://github.com/eWaterCycle/era5cli/issues/22>`_.
 
 1.0.0rc1 (2019-06-22)
-=====================
+~~~~~~~~~~~~~~~~~~~~~
 * First Release Candidate for the stable 1.0.0 era5cli release: A commandline utility to download ERA-5 data using cdsapi.
diff --git a/CITATION.cff b/CITATION.cff
@@ -42,12 +42,12 @@ authors:
     given-names: Rolf
 
 cff-version: "1.0.3"
-date-released: 2019-07-01
+date-released: 2019-07-15
 doi: 10.5281/zenodo.3252665
 keywords: 
   - "ERA5"
 license: Apache-2.0
 message: "If you use this software, please cite it using these metadata."
 repository-code: "https://github.com/ewatercycle/era5cli"
 title: era5cli
-version: 1.0.0rc2
+version: 1.0.0rc3
diff --git a/LICENSE b/LICENSE
@@ -1,5 +1,7 @@
                                  Apache License
+
                            Version 2.0, January 2004
+
                         http://www.apache.org/licenses/
 
    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

diff --git a/README.rst b/README.rst
@@ -22,8 +22,19 @@ era5cli
 .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3252665.svg
    :target: https://doi.org/10.5281/zenodo.3252665
 
+.. inclusion-marker-start-do-not-remove
+
 A command line interface to download ERA5 data from the `Copernicus Climate Data Store <https://climate.copernicus.eu/>`_.
 
+With era5cli you can: 
+
+- download meteorological data in GRIB/NetCDF
+- list and retrieve information on available variables and pressure levels
+- select multiple variables for several months and years
+- split outputs by years, producing a separate file for every year instead of merging them in one file
+- download multiple files at once
+
+.. inclusion-marker-end-do-not-remove
 
-* Free software: Apache Software License 2.0
-* Documentation: https://era5cli.readthedocs.io.
+| Free software: Apache Software License 2.0 
+| Documentation: https://era5cli.readthedocs.io
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -22,10 +22,10 @@
 
 project = 'era5cli'
 copyright = '2019, Netherlands eScience Center'
-author = 'Ronald van Haren'
+author = 'era5cli team'
 
 # The full version, including alpha/beta/rc tags
-release = '1.0.0rc2'
+release = '1.0.0rc3'
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/docs/source/contribute.rst b/docs/source/contribute.rst
@@ -0,0 +1,9 @@
+Reporting bugs
+**************
+
+File bug reports or feature requests, and make contributions (e.g. code patches), by opening a "new issue" on GitHub:
+
+- era5cli Issues: https://github.com/ewatercycle/era5cli/issues
+
+Please give as much information as you can in the issue. It is very useful if you can supply the command or a small self-contained code snippet that reproduces the problem. Please also specify the era5cli version that you
+are using and the version of the cdsapi library installed. 
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,19 +1,34 @@
 Welcome to era5cli's documentation!
 ===================================
 .. include:: ../../README.rst
+  :start-after: inclusion-marker-start-do-not-remove
+  :end-before: inclusion-marker-end-do-not-remove
+
+Content
+~~~~~~~
 
 .. toctree::
    :maxdepth: 2
 
    installation
    instructions
-   changes
    api
 
 
 Indices and tables
-==================
+~~~~~~~~~~~~~~~~~~
 
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
+
+
+Meta Information
+~~~~~~~~~~~~~~~~
+
+.. toctree::
+   :maxdepth: 1
+
+   contribute
+   changes
+   license
diff --git a/docs/source/installation.rst b/docs/source/installation.rst
@@ -1,17 +1,17 @@
 Installation
 ------------
 
-Install from PyPI:
-~~~~~~~~~~~~~~~~~~
-era5cli is available as a package in PyPI <https://pypi.org/project/era5cli/>.
+Install from PyPI
+~~~~~~~~~~~~~~~~~
+era5cli is available as a package in `PyPI <https://pypi.org/project/era5cli/>`_.
 
 To install from PyPI, the following command can be used:
 ::
 
    pip install era5cli
 
-Install from GitHub:
-~~~~~~~~~~~~~~~~~~~~
+Install from GitHub
+~~~~~~~~~~~~~~~~~~~
 To install directly from GitHub, the following command can be used:
 ::
 

diff --git a/docs/source/instructions.rst b/docs/source/instructions.rst
@@ -101,6 +101,6 @@ For the monthly data, some of the variables are not available. Exceptions on the
 Removing or canceling requests
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-ERA-5 download requests will be saved in the `Your requests section of the Copernicus Climate Data Service <https://cds.climate.copernicus.eu/cdsapp#!/yourrequests>`_. Here you can re-download the requested data, cancel active requests, or remove old requests. 
+ERA-5 download requests will be saved in the `Your requests <https://cds.climate.copernicus.eu/cdsapp#!/yourrequests>`_ section in your profile on the Copernicus Climate Data Store. Here you can re-download the requested data, cancel active requests, or remove old requests. 
 
 Note that it is currently not possible to cancel active requests from the command line: Killing the process will not download the data to your local machine but still add it to your Copernicus account.
diff --git a/docs/source/license.rst b/docs/source/license.rst
@@ -0,0 +1,4 @@
+License
+*******
+
+.. include:: ../../LICENSE
diff --git a/era5cli/__version__.py b/era5cli/__version__.py
@@ -10,4 +10,4 @@
               'Niels Drost', 'Fakhereh Alidoost', 'Bouwe Andela',
               'Jerom Aerts', 'Berend Weel', 'Rolf Hut')
 __email__ = '[email protected]'
-__version__ = '1.0.0rc2'
+__version__ = '1.0.0rc3'
diff --git a/era5cli/cli.py b/era5cli/cli.py
@@ -36,9 +36,9 @@ def _build_parser():
         "--variables", type=str, required=True, nargs="+",
         help=textwrap.dedent('''\
                              The variables to be downloaded, can be a single
-                             or multiple variables. See the cds
-                             website or run "era5cli info -h" for available
-                             variables.
+                             or multiple variables. See the Copernicus Climate
+                             Data Store website or run "era5cli info -h" for
+                             available variables.
 
                              ''')
     )
@@ -101,8 +101,7 @@ def _build_parser():
         "--split", type=_str2bool, default=True,
         help=textwrap.dedent('''\
                              Split output by years, producing a separate file
-                             for every year. Default
-                             is True.
+                             for every year. Default is True.
 
                              ''')
     )