Skip to content

Commit

Permalink
Merge branch 'master' into yohai-ds_scatter
Browse files Browse the repository at this point in the history
* master: (29 commits)
  Handle the character array dim name  (pydata#2896)
  Partial fix for pydata#2841 to improve formatting. (pydata#2906)
  docs: Move quick overview one level up (pydata#2890)
  Manually specify chunks in open_zarr (pydata#2530)
  Minor improvement of docstring for Dataset (pydata#2904)
  Fix minor typos in docstrings (pydata#2903)
  Added docs example for `xarray.Dataset.get()` (pydata#2894)
  Bugfix for docs build instructions (pydata#2897)
  Return correct count for scalar datetime64 arrays (pydata#2892)
  Indexing with an empty array (pydata#2883)
  BUG: Fix pydata#2864 by adding the missing vrt parameters (pydata#2865)
  Reduce length of cftime resample tests (pydata#2879)
  WIP: type annotations (pydata#2877)
  decreased pytest verbosity (pydata#2881)
  Fix mypy typing error in cftime_offsets.py (pydata#2878)
  update links to https (pydata#2872)
  revert to 0.12.2 dev
  0.12.1 release
  Various fixes for explicit Dataset.indexes (pydata#2858)
  Fix minor typo in docstring (pydata#2860)
  ...
  • Loading branch information
dcherian committed Apr 19, 2019
2 parents ee662b4 + 6d93a95 commit 41cca04
Show file tree
Hide file tree
Showing 41 changed files with 1,375 additions and 729 deletions.
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ script:
elif [[ "$CONDA_ENV" == "py36-hypothesis" ]]; then
pytest properties ;
else
py.test xarray --cov=xarray --cov-config ci/.coveragerc --cov-report term-missing --verbose $EXTRA_FLAGS;
py.test xarray --cov=xarray --cov-config ci/.coveragerc --cov-report term-missing $EXTRA_FLAGS;
fi

after_success:
Expand Down
26 changes: 13 additions & 13 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ xarray: N-D labeled arrays and datasets
.. image:: https://coveralls.io/repos/pydata/xarray/badge.svg
:target: https://coveralls.io/r/pydata/xarray
.. image:: https://readthedocs.org/projects/xray/badge/?version=latest
:target: http://xarray.pydata.org/
.. image:: http://img.shields.io/badge/benchmarked%20by-asv-green.svg?style=flat
:target: http://pandas.pydata.org/speed/xarray/
:target: https://xarray.pydata.org/
.. image:: https://img.shields.io/badge/benchmarked%20by-asv-green.svg?style=flat
:target: https://pandas.pydata.org/speed/xarray/
.. image:: https://img.shields.io/pypi/v/xarray.svg
:target: https://pypi.python.org/pypi/xarray/

Expand All @@ -30,10 +30,10 @@ It is particularly tailored to working with netCDF_ files, which were the
source of xarray's data model, and integrates tightly with dask_ for parallel
computing.

.. _NumPy: http://www.numpy.org
.. _pandas: http://pandas.pydata.org
.. _dask: http://dask.org
.. _netCDF: http://www.unidata.ucar.edu/software/netcdf
.. _NumPy: https://www.numpy.org
.. _pandas: https://pandas.pydata.org
.. _dask: https://dask.org
.. _netCDF: https://www.unidata.ucar.edu/software/netcdf

Why xarray?
-----------
Expand Down Expand Up @@ -66,12 +66,12 @@ powerful and concise interface. For example:
Documentation
-------------

Learn more about xarray in its official documentation at http://xarray.pydata.org/
Learn more about xarray in its official documentation at https://xarray.pydata.org/

Contributing
------------

You can find information about contributing to xarray at our `Contributing page <http://xarray.pydata.org/en/latest/contributing.html#>`_.
You can find information about contributing to xarray at our `Contributing page <https://xarray.pydata.org/en/latest/contributing.html#>`_.

Get in touch
------------
Expand All @@ -81,9 +81,9 @@ Get in touch
- For less well defined questions or ideas, or to announce other projects of
interest to xarray users, use the `mailing list`_.

.. _StackOverFlow: http://stackoverflow.com/questions/tagged/python-xarray
.. _StackOverFlow: https://stackoverflow.com/questions/tagged/python-xarray
.. _mailing list: https://groups.google.com/forum/#!forum/xarray
.. _on GitHub: http://github.com/pydata/xarray
.. _on GitHub: https://github.com/pydata/xarray

NumFOCUS
--------
Expand All @@ -97,7 +97,7 @@ to supporting the open source scientific computing community. If you like
Xarray and want to support our mission, please consider making a donation_
to support our efforts.

.. _donation: https://www.flipcause.com/secure/cause_pdetails/NDE2NTU=
.. _donation: https://numfocus.salsalabs.org/donate-to-xarray/

History
-------
Expand All @@ -120,7 +120,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0
https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
Expand Down
2 changes: 1 addition & 1 deletion ci/requirements-py35-min.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: test_env
dependencies:
- python=3.5
- python=3.5.0
- pytest
- flake8
- mock
Expand Down
20 changes: 13 additions & 7 deletions doc/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -285,17 +285,23 @@ How to build the *xarray* documentation

Requirements
~~~~~~~~~~~~
Make sure to follow the instructions on :ref:`creating a development environment above <contributing.dev_env>`, but
to build the docs you need to use the environment file ``doc/environment.yml``.

First, you need to have a development environment to be able to build xarray
(see the docs on :ref:`creating a development environment above <contributing.dev_env>`).
.. code-block:: none
Building the documentation
~~~~~~~~~~~~~~~~~~~~~~~~~~
# Create and activate the docs environment
conda env create -f doc/environment.yml
conda activate xarray-docs
In your development environment, install ``sphinx``, ``sphinx_rtd_theme``,
``sphinx-gallery`` and ``numpydoc``::
# or with older versions of Anaconda:
source activate xarray-docs
conda install -c conda-forge sphinx sphinx_rtd_theme sphinx-gallery numpydoc
# Build and install xarray
pip install -e .
Building the documentation
~~~~~~~~~~~~~~~~~~~~~~~~~~

Navigate to your local ``xarray/doc/`` directory in the console and run::

Expand Down
14 changes: 4 additions & 10 deletions doc/data-structures.rst
Original file line number Diff line number Diff line change
Expand Up @@ -353,13 +353,6 @@ setting) variables and attributes:
This is particularly useful in an exploratory context, because you can
tab-complete these variable names with tools like IPython.

.. warning::

We are changing the behavior of iterating over a Dataset the next major
release of xarray, to only include data variables instead of both data
variables and coordinates. In the meantime, prefer iterating over
``ds.data_vars`` or ``ds.coords``.

Dictionary like methods
~~~~~~~~~~~~~~~~~~~~~~~

Expand All @@ -370,6 +363,7 @@ example, to create this example dataset from scratch, we could have written:
ds = xr.Dataset()
ds['temperature'] = (('x', 'y', 'time'), temp)
ds['temperature_double'] = (('x', 'y', 'time'), temp * 2 )
ds['precipitation'] = (('x', 'y', 'time'), precip)
ds.coords['lat'] = (('x', 'y'), lat)
ds.coords['lon'] = (('x', 'y'), lon)
Expand Down Expand Up @@ -404,9 +398,9 @@ operations keep around coordinates:

.. ipython:: python
list(ds[['temperature']])
list(ds[['x']])
list(ds.drop('temperature'))
ds[['temperature']]
ds[['temperature', 'temperature_double']]
ds.drop('temperature')
To remove a dimension, you can use :py:meth:`~xarray.Dataset.drop_dims` method.
Any variables using that dimension are dropped:
Expand Down
1 change: 0 additions & 1 deletion doc/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ Examples
.. toctree::
:maxdepth: 2

examples/quick-overview
examples/weather-data
examples/monthly-means
examples/multidimensional-coords
Expand Down
183 changes: 0 additions & 183 deletions doc/examples/quick-overview.rst

This file was deleted.

4 changes: 3 additions & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ Documentation

* :doc:`why-xarray`
* :doc:`faq`
* :doc:`quick-overview`
* :doc:`examples`
* :doc:`installing`

Expand All @@ -39,6 +40,7 @@ Documentation

why-xarray
faq
quick-overview
examples
installing

Expand Down Expand Up @@ -140,7 +142,7 @@ to supporting the open source scientific computing community. If you like
Xarray and want to support our mission, please consider making a donation_
to support our efforts.

.. _donation: https://www.flipcause.com/secure/cause_pdetails/NDE2NTU=
.. _donation: https://numfocus.salsalabs.org/donate-to-xarray/


History
Expand Down
Loading

0 comments on commit 41cca04

Please sign in to comment.