Merge pull request #124 from andersy005/release-2019.04.27

Update documentation for next release

CHANGELOG.rst

@@ -1,8 +1,8 @@
 ==================
-Changelog history
+Changelog History
 ==================
 
-Esmlab v2019.4. (2019-04)
+Esmlab v2019.4.27 (2019-04-27)
 ==============================
 
 Features
@@ -19,6 +19,15 @@ Bug Fixes
 ---------
 - Fix bug that made computing annual mean with ``resample(ds, freq='ann')`` yield incorrect results. (:issue:`112`) (:pr:`115`) `Anderson Banihirwe`_
 - Fix time and time_bounds decoding incosistencies in ``resample(ds, freq='ann')`` results for ``decode_time=True``. (:issue:`111`) (:pr:`115`) `Anderson Banihirwe`_
+- Fix cftime datetime decoding/encoding (:issue:`118`) (:pr:`122`) `Anderson Banihirwe`_
+
+
+
+Trivial/Internal Changes
+-------------------------
+
+- Move regridding utilities to esmlab-regrid repo (:pr:`107`) `Anderson Banihirwe`_
+- Switch from versioneer to setuptools-scm (:pr:`120`) `Anderson Banihirwe`_
 
 
 Esmlab v2019.3.16 (2019-03-16)

MANIFEST.in

@@ -3,11 +3,8 @@ recursive-include esmlab *.yaml
 include LICENSE
 include README.rst
 include requirements.txt
-include CONTRIBUTING.rst
-include HOWTORELEASE.rst
 
-recursive-include tests *.py
-recursive-include tests/data/*.nc
-recursive-include tests/utils/*.py
 recursive-exclude * __pycache__
 recursive-exclude * *.py[co]
+prune tests*
+prune ci*

README.rst

@@ -30,3 +30,19 @@ Tools for working with earth system multi-model analyses with xarray. See
 documentation_ for more information.
 
 .. _documentation: https://esmlab.readthedocs.io/en/latest/
+
+Installation
+------------
+
+ESMLab can be installed from PyPI with pip:
+
+.. code-block:: bash
+
+    pip install esmlab
+
+
+It is also available from `conda-forge` for conda installations:
+
+.. code-block:: bash
+
+    conda install -c conda-forge esmlab

docs/source/conf.py

@@ -89,7 +89,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.ipynb_checkpoints']
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'

docs/source/install.rst

@@ -27,7 +27,7 @@ To install esmlab from source, clone the repository from `github
 
     git clone https://github.com/NCAR/esmlab.git
     cd esmlab
-    pip install .
+    pip install -e .
 
 You can also install directly from git master branch::
 
@@ -37,8 +37,8 @@ You can also install directly from git master branch::
 Test
 ----
 
-Test esmlab with ``pytest``::
+To run esmlab's tests with ``pytest``::
 
     git clone https://github.com/NCAR/esmlab.git
     cd esmlab
-    pytest - v
+    pytest - v

setup.py

@@ -25,7 +25,6 @@
     'Intended Audience :: Science/Research',
     'Programming Language :: Python',
     'Programming Language :: Python :: 3',
-    'Programming Language :: Python :: 3.5',
     'Programming Language :: Python :: 3.6',
     'Programming Language :: Python :: 3.7',
     'Topic :: Scientific/Engineering',
@@ -37,12 +36,12 @@
     maintainer_email='[email protected]',
     description='Tools for working with earth system multi-model analyses with xarray',
     install_requires=install_requires,
-    python_requires='>=3.5',
+    python_requires='>3.5',
     license='Apache License 2.0',
     long_description=long_description,
     classifiers=CLASSIFIERS,
     name='esmlab',
-    packages=find_packages(),
+    packages=find_packages(exclude=('tests',)),
     test_suite='tests',
     include_package_data=True,
     tests_require=test_requirements,

tests/test_config.py

@@ -219,7 +219,7 @@ def test_ensure_file(tmpdir):
     ensure_file(source=source, destination=dest, comment=False)
 
     with open(destination) as f:
-        result = yaml.load(f)
+        result = yaml.safe_load(f)
     assert result == a
 
     # don't overwrite old config files
@@ -229,7 +229,7 @@ def test_ensure_file(tmpdir):
     ensure_file(source=source, destination=dest, comment=False)
 
     with open(destination) as f:
-        result = yaml.load(f)
+        result = yaml.safe_load(f)
     assert result == a
 
     os.remove(destination)
@@ -242,7 +242,7 @@ def test_ensure_file(tmpdir):
     assert '123' in text
 
     with open(destination) as f:
-        result = yaml.load(f)
+        result = yaml.safe_load(f)
     assert not result