v0.1.0 release (xgcm#67)

* ready for release

* Bump version: 0.0.0 → 0.1.0

* fixed bumpversion

* trying to fix version

* Bump version: 0.0.0 → 0.1.0

* Update README.rst

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.0.0
+current_version = 0.1.0
 commit = True
 tag = True
 

README.rst

@@ -0,0 +1,52 @@
+xgcm: General Circulation Model Postprocessing with xarray
+==========================================================
+
+|pypi| |Build Status| |codecov| |docs| |DOI| |license|
+
+**xgcm** is a python packge for working with the datasets produced by numerical
+`General Circulation Models <https://en.wikipedia.org/wiki/General_circulation_model>`_
+(GCMs) and similar gridded datasets that are amenable to
+`finite volume <https://en.wikipedia.org/wiki/Finite_volume_method>`_ analysis.
+In these datasets, different variables are located at different positions with
+respect to a volume or area element (e.g. cell center, cell face, etc.)
+xgcm solves the problem of how to interpolate and difference these variables
+from one position to another.
+
+xgcm consumes and produces xarray_ data structures, which are coordinate and
+metadata-rich representations of multidimensional array data. xarray is ideal
+for analyzing GCM data in many ways, providing convenient indexing and grouping,
+coordinate-aware data transformations, and (via dask_) parallel,
+out-of-core array computation. On top of this, xgcm adds an understanding of
+the finite volume `Arakawa Grids`_ commonly used in ocean and atmospheric
+models and differential and integral operators suited to these grids.
+
+xgcm was motivated by the rapid growth in the numerical resolution of
+ocean, atmosphere, and climate models. While highly parallel supercomputers can
+now easily generate tera- and petascale datasets, common post-processing
+workflows struggle with these volumes. Furthermore, we believe that a flexible,
+evolving, open-source, python-based framework for GCM analysis will enhance
+the productivity of the field as a whole, accelerating the rate of discovery in
+climate science. xgcm is part of the Pangeo_ initiative.
+
+.. _Pangeo: http://pangeo-data.github.io
+.. _dask: http://dask.pydata.org
+.. _xarray: http://xarray.pydata.org
+.. _Arakawa Grids: https://en.wikipedia.org/wiki/Arakawa_grid
+
+.. |DOI| image:: https://zenodo.org/badge/70649781.svg
+   :target: https://zenodo.org/badge/latestdoi/70649781
+.. |Build Status| image:: https://travis-ci.org/xgcm/xgcm.svg?branch=master
+   :target: https://travis-ci.org/xgcm/xgcm
+   :alt: travis-ci build status
+.. |codecov| image:: https://codecov.io/github/xgcm/xgcm/coverage.svg?branch=master
+   :target: https://codecov.io/github/xgcm/xgcm?branch=master
+   :alt: code coverage
+.. |pypi| image:: https://badge.fury.io/py/xgcm.svg
+   :target: https://badge.fury.io/py/xgcm
+   :alt: pypi package
+.. |docs| image:: http://readthedocs.org/projects/xgcm/badge/?version=stable
+   :target: http://xgcm.readthedocs.org/en/stable/?badge=stable
+   :alt: documentation status
+.. |license| image:: https://img.shields.io/github/license/mashape/apistatus.svg
+   :target: https://github.com/xgcm/xgcm
+   :alt: license

setup.py

@@ -6,9 +6,7 @@
 
 from setuptools import setup, find_packages
 
-ISRELEASED = False
-VERSION = '0.0.0'
-
+VERSION = '0.1.0'
 DISTNAME = 'xgcm'
 LICENSE = 'MIT'
 AUTHOR = 'xgcm Developers'
@@ -32,9 +30,11 @@
 SETUP_REQUIRES = ['pytest-runner']
 TESTS_REQUIRE = ['pytest >= 2.8', 'coverage']
 
-DESCRIPTION = "General circulation model analysis in python with xarray"
-LONG_DESCRIPTION = """To be written.
-"""
+DESCRIPTION = "General Circulation Model Postprocessing with xarray"
+def readme():
+    with open('README.rst') as f:
+        return f.read()
+
 
 setup(name=DISTNAME,
       version=VERSION,
@@ -43,7 +43,7 @@
       author_email=AUTHOR_EMAIL,
       classifiers=CLASSIFIERS,
       description=DESCRIPTION,
-      long_description=LONG_DESCRIPTION,
+      long_description=readme(),
       install_requires=INSTALL_REQUIRES,
       setup_requires=SETUP_REQUIRES,
       tests_require=TESTS_REQUIRE,

xgcm/__init__.py

@@ -1,2 +1,2 @@
-__version__ = "0.0.0"
+__version__ = "0.1.0"
 from .grid import Grid, Axis

xgcm/grid.py

@@ -197,7 +197,7 @@ def _neighbor_binary_func(self, da, f, to, boundary=None, fill_value=0.0):
             The data on which to operate
         f : function
             With signature f(da_left, da_right, shift)
-        to : {'center', 'left', 'right', 'outer'}
+        to : {'center', 'left', 'right', 'inner', 'outer'}
             The direction in which to shift the array. If not specified,
             default will be used.
         boundary : {None, 'fill', 'extend'}