release candidate 0.5.0 (#356)

README.md

@@ -8,7 +8,7 @@ pyam: analysis and visualization of integrated-assessment scenarios
 Overview and scope
 ------------------
 
-The open-source Python package ``pyam`` provides a suite of tools and functions
+The open-source Python package **pyam** provides a suite of tools and functions
 for analyzing and visualizing input data (i.e., assumptions/parametrization) 
 and results (model output) of integrated-assessment scenarios.
 
@@ -68,9 +68,9 @@ and Daniel Huppmann ([@danielhuppmann](https://github.com/danielhuppmann/)).
 License
 -------
 
-Copyright 2017-2019 IIASA Energy Program
+Copyright 2017-2020 IIASA Energy Program
 
-The ``pyam`` package is licensed
+The **pyam** package is licensed
 under the Apache License, Version 2.0 (the "License");
 see [LICENSE](LICENSE) and [NOTICE](NOTICE.md) for details.
 

RELEASE_NOTES.md

@@ -1,4 +1,20 @@
-# Next release
+# Release v0.5.0
+
+## Highlights
+
+- Improved feature for unit conversion 
+  using the [pint package](https://pint.readthedocs.io) and
+  the [IAMconsortium/units](https://github.com/IAMconsortium/units) repository,
+  providing out-of-the-box conversion of unit definitions commonly used
+  in integrated assessment research and energy systems modelling;
+  see [this tutorial](https://pyam-iamc.readthedocs.io/en/stable/tutorials/unit_conversion.html)
+  for more information
+- Increased support for operations on timeseries data with continuous-time
+  resolution
+- New tutorial for working with various input data formats; 
+  [take a look](https://pyam-iamc.readthedocs.io/en/stable/tutorials/data_table_formats.html)
+- Rewrite and extension of the documentation pages for the API;
+  [read the new docs](https://pyam-iamc.readthedocs.io/en/stable/api.html)!
 
 ## API changes
 

doc/source/data.rst

@@ -80,8 +80,8 @@ mode (beta):
 Please reach out to the developers to get more information on this
 ongoing work.
 
-The :class:`IamDataFrame` class
--------------------------------
+The **IamDataFrame** class
+--------------------------
 
 A :class:`pyam.IamDataFrame` instance is a wrapper for
 two :class:`pandas.DataFrame` instances (i.e., tables, see the `pandas docs`_

doc/source/index.rst

@@ -25,8 +25,8 @@ Release v\ |version|.
    :target: https://pyam-iamc.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status
 
-.. |travis| image:: https://travis-ci.org/IAMconsortium/pyam.svg?branch=master
-   :target: https://travis-ci.org/IAMconsortium/pyam
+.. |travis| image:: https://travis-ci.com/IAMconsortium/pyam.svg?branch=master
+   :target: https://travis-ci.com/IAMconsortium/pyam
 
 .. |appveyor| image:: https://ci.appveyor.com/api/projects/status/qd4taojd2vkqoab4/branch/master?svg=true&passingText=passing&failingText=failing&pendingText=pending
    :target: https://ci.appveyor.com/project/gidden/pyam/branch/master

pyam/core.py

@@ -1316,12 +1316,6 @@ def to_excel(self, excel_writer, sheet_name='data', iamc_index=False,
         if close:
             excel_writer.close()
 
-    def export_metadata(self, excel_writer, sheet_name='meta'):
-        """Deprecated, see :meth:`export_meta()`"""
-        # TODO: deprecate in next release (>=0.5.0)
-        deprecation_warning('Use `export_meta()` instead!')
-        self.export_meta(excel_writer, sheet_name='meta')
-
     def export_meta(self, excel_writer, sheet_name='meta'):
         """Write the 'meta' table of this object to an Excel sheet
 
@@ -1352,7 +1346,7 @@ def to_datapackage(self, path):
 
         Parameters
         ----------
-        path: string or path object
+        path : string or path object
             any valid string path or :class:`pathlib.Path`
         """
         if not HAS_DATAPACKAGE:
@@ -1373,12 +1367,6 @@ def to_datapackage(self, path):
         # return the package (needs to reloaded because `tmp` was deleted)
         return Package(path)
 
-    def load_metadata(self, path, *args, **kwargs):
-        """Deprecated, see :meth:`load_meta`"""
-        # TODO: deprecate in next release (>=0.5.0)
-        deprecation_warning('Use `load_meta()` instead!')
-        self.load_meta(path, *args, **kwargs)
-
     def load_meta(self, path, *args, **kwargs):
         """Load 'meta' table from file
 
@@ -1880,7 +1868,7 @@ def read_datapackage(path, data='data', meta='meta'):
     ----------
     path : string or path object
         any valid string path or :class:`pathlib.Path`, |br|
-        passed to :class:`datapackage.Package()` (|datapackage.Package.docs|)
+        passed to :class:`datapackage.Package` (|datapackage.Package.docs|)
     data : str, default 'data'
         resource containing timeseries data in IAMC-compatible format
     meta : str, default 'meta'

setup.py

@@ -38,6 +38,8 @@
     'deploy': ['twine', 'setuptools', 'wheel'],
 }
 
+with open('README.md', 'r') as f:
+    LONG_DESCRIPTION = f.read()
 
 # thank you https://stormpath.com/blog/building-simple-cli-interfaces-in-python
 class RunTests(Command):
@@ -84,23 +86,25 @@ def main():
     }
     install_requirements = REQUIREMENTS
     extra_requirements = EXTRA_REQUIREMENTS
-    setup_kwargs = {
-        'name': 'pyam-iamc',
-        'version': versioneer.get_version(),
-        'cmdclass': CMDCLASS,
-        'description': description,
-        'classifiers': classifiers,
-        'license': 'Apache License 2.0',
-        'author': 'Matthew Gidden & Daniel Huppmann',
-        'author_email': 'matthew.gidden@gmail.com',
-        'url': 'https://github.com/IAMconsortium/pyam',
-        'packages': packages,
-        'package_dir': pack_dir,
-        'entry_points': entry_points,
-        'package_data': package_data,
-        'install_requires': install_requirements,
-        'extras_require': extra_requirements,
-    }
+    setup_kwargs = dict(
+        name='pyam-iamc',
+        version=versioneer.get_version(),
+        cmdclass=CMDCLASS,
+        description=description,
+        classifiers=classifiers,
+        license='Apache License 2.0',
+        author='Matthew Gidden & Daniel Huppmann',
+        author_email='pyam+owner@groups.io',
+        url='https://github.com/IAMconsortium/pyam',
+        long_description=LONG_DESCRIPTION,
+        long_description_content_type='text/markdown',
+        packages=packages,
+        package_dir=pack_dir,
+        entry_points=entry_points,
+        package_data=package_data,
+        install_requires=install_requirements,
+        extras_require=extra_requirements,
+    )
     rtn = setup(**setup_kwargs)