Skip to content

Commit f3c5fd3

Browse files
committed
Merge pull request #720 from pydata/rename-xarray
Rename xray -> xarray
2 parents 62e74a7 + 68a8ab6 commit f3c5fd3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

90 files changed

+842
-795
lines changed

.coveragerc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
[run]
2-
omit = xray/test/*
2+
omit = xarray/test/*

.gitignore

+2-2
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,10 @@ nosetests.xml
3939
.idea
4040
*.swp
4141

42-
# xray specific
42+
# xarray specific
4343
doc/_build
4444
doc/generated
4545
doc/_static/*.png
46-
xray/version.py
46+
xarray/version.py
4747

4848
.ipynb_checkpoints

.travis.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ install:
6464
- python setup.py install
6565

6666
script:
67-
- py.test xray --cov=xray --cov-report term-missing
67+
- py.test xarray --cov=xarray --cov-report term-missing
6868

6969
after_success:
7070
- coveralls

README.rst

+31-31
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,36 @@
1-
xray: N-D labeled arrays and datasets
2-
=====================================
1+
xarray: N-D labeled arrays and datasets
2+
=======================================
33

4-
.. image:: https://travis-ci.org/xray/xray.svg?branch=master
5-
:target: https://travis-ci.org/xray/xray
6-
.. image:: https://ci.appveyor.com/api/projects/status/github/xray/xray?svg=true&passingText=passing&failingText=failing&pendingText=pending
4+
.. image:: https://travis-ci.org/pydata/xarray.svg?branch=master
5+
:target: https://travis-ci.org/pydata/xarray
6+
.. image:: https://ci.appveyor.com/api/projects/status/github/pydata/xarray?svg=true&passingText=passing&failingText=failing&pendingText=pending
77
:target: https://ci.appveyor.com/project/shoyer/xray
8-
.. image:: https://coveralls.io/repos/xray/xray/badge.svg
9-
:target: https://coveralls.io/r/xray/xray
10-
.. image:: https://landscape.io/github/xray/xray/master/landscape.svg?style=flat
11-
:target: https://landscape.io/github/xray/xray/master
12-
.. image:: https://img.shields.io/pypi/v/xray.svg
13-
:target: https://pypi.python.org/pypi/xray/
8+
.. image:: https://coveralls.io/repos/pydata/xarray/badge.svg
9+
:target: https://coveralls.io/r/pydata/xarray
10+
.. image:: https://landscape.io/github/pydata/xarray/master/landscape.svg?style=flat
11+
:target: https://landscape.io/github/pydata/xarray/master
12+
.. image:: https://img.shields.io/pypi/v/xarray.svg
13+
:target: https://pypi.python.org/pypi/xarray/
1414
.. image:: https://badges.gitter.im/Join%20Chat.svg
15-
:target: https://gitter.im/xray/xray
15+
:target: https://gitter.im/pydata/xarray
1616

17-
**xray** is an open source project and Python package that aims to bring the
17+
**xarray** (formerly **xray**) is an open source project and Python package that aims to bring the
1818
labeled data power of pandas_ to the physical sciences, by providing
1919
N-dimensional variants of the core pandas data structures.
2020

2121
Our goal is to provide a pandas-like and pandas-compatible toolkit for
2222
analytics on multi-dimensional arrays, rather than the tabular data for which
2323
pandas excels. Our approach adopts the `Common Data Model`_ for self-
2424
describing scientific data in widespread use in the Earth sciences:
25-
``xray.Dataset`` is an in-memory representation of a netCDF file.
25+
``xarray.Dataset`` is an in-memory representation of a netCDF file.
2626

2727
.. _pandas: http://pandas.pydata.org
2828
.. _Common Data Model: http://www.unidata.ucar.edu/software/thredds/current/netcdf-java/CDM
2929
.. _netCDF: http://www.unidata.ucar.edu/software/netcdf
3030
.. _OPeNDAP: http://www.opendap.org/
3131

32-
Why xray?
33-
---------
32+
Why xarray?
33+
-----------
3434

3535
Adding dimensions names and coordinate indexes to numpy's ndarray_ makes many
3636
powerful array operations possible:
@@ -43,7 +43,7 @@ powerful array operations possible:
4343
- Flexible split-apply-combine operations with groupby:
4444
``x.groupby('time.dayofyear').mean()``.
4545
- Database like alignment based on coordinate labels that smoothly
46-
handles missing values: ``x, y = xray.align(x, y, join='outer')``.
46+
handles missing values: ``x, y = xr.align(x, y, join='outer')``.
4747
- Keep track of arbitrary metadata in the form of a Python dictionary:
4848
``x.attrs``.
4949

@@ -55,19 +55,19 @@ Why isn't pandas enough?
5555

5656
pandas_ excels at working with tabular data. That suffices for many statistical
5757
analyses, but physical scientists rely on N-dimensional arrays -- which is
58-
where xray comes in.
58+
where xarray comes in.
5959

60-
xray aims to provide a data analysis toolkit as powerful as pandas_ but
60+
xarray aims to provide a data analysis toolkit as powerful as pandas_ but
6161
designed for working with homogeneous N-dimensional arrays
6262
instead of tabular data. When possible, we copy the pandas API and rely on
6363
pandas's highly optimized internals (in particular, for fast indexing).
6464

6565
Why netCDF?
6666
-----------
6767

68-
Because xray implements the same data model as the netCDF_ file format,
69-
xray datasets have a natural and portable serialization format. But it is also
70-
easy to robustly convert an xray ``DataArray`` to and from a numpy ``ndarray``
68+
Because xarray implements the same data model as the netCDF_ file format,
69+
xarray datasets have a natural and portable serialization format. But it is also
70+
easy to robustly convert an xarray ``DataArray`` to and from a numpy ``ndarray``
7171
or a pandas ``DataFrame`` or ``Series``, providing compatibility with the full
7272
`PyData ecosystem <http://pydata.org/>`__.
7373

@@ -82,28 +82,28 @@ especially geoscientists who already know and love netCDF_.
8282
Documentation
8383
-------------
8484

85-
The official documentation is hosted on ReadTheDocs: http://xray.readthedocs.org/
85+
The official documentation is hosted on ReadTheDocs at http://xarray.pydata.org/
8686

8787
Get in touch
8888
------------
8989

90-
- GitHub issue tracker: https://github.com/xray/xray/issues/
91-
- Mailing list: https://groups.google.com/forum/#!forum/xray-dev
92-
- Twitter: http://twitter.com/shoyer
90+
- GitHub issue tracker: https://github.com/pydata/xarray/issues/
91+
- Mailing list: https://groups.google.com/forum/#!forum/xarray
9392

9493
History
9594
-------
9695

97-
xray is an evolution of an internal tool developed at `The Climate
98-
Corporation`__, and was originally written by current and former Climate Corp
99-
researchers Stephan Hoyer, Alex Kleeman and Eugene Brevdo.
96+
xarray is an evolution of an internal tool developed at `The Climate
97+
Corporation`__. It was originally written by Climate Corp researchers Stephan
98+
Hoyer, Alex Kleeman and Eugene Brevdo and was released as open source in
99+
May 2014. The project was renamed from "xray" in January 2016.
100100

101101
__ http://climate.com/
102102

103103
License
104104
-------
105105

106-
Copyright 2014, xray Developers
106+
Copyright 2014-2016, xarray Developers
107107

108108
Licensed under the Apache License, Version 2.0 (the "License");
109109
you may not use this file except in compliance with the License.
@@ -117,5 +117,5 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
117117
See the License for the specific language governing permissions and
118118
limitations under the License.
119119

120-
xray includes portions of pandas, NumPy and Seaborn. Their licenses are
120+
xarray includes portions of pandas, NumPy and Seaborn. Their licenses are
121121
included in the licenses directory.

appveyor.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@ install:
2525
- "python --version"
2626
- "python -c \"import struct; print(struct.calcsize('P') * 8)\""
2727

28-
# install xray and depenencies
28+
# install xarray and depenencies
2929
- "conda install --yes --quiet pip pytest numpy pandas scipy netCDF4 matplotlib dask"
3030
- "python setup.py install"
3131

3232
build: false
3333

3434
test_script:
35-
- "py.test xray"
35+
- "py.test xarray"

doc/_static/dataset-diagram-logo.png

-15.8 KB
Loading

doc/_static/dataset-diagram-logo.tex

+29-15
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@
174174
emphstyle=ultra thick,
175175
}
176176
\tikzcuboid{%
177-
shiftx=26.2cm,%
177+
shiftx=26.8cm,%
178178
shifty=8cm,%
179179
scale=1.00,%
180180
rotation=0,%
@@ -194,7 +194,7 @@
194194
emphstyle=ultra thick,
195195
}
196196
\tikzcuboid{%
197-
shiftx=27.6cm,%
197+
shiftx=28.6cm,%
198198
shifty=8cm,%
199199
scale=1.00,%
200200
rotation=0,%
@@ -214,23 +214,36 @@
214214
emphstyle=ultra thick,
215215
}
216216
% \tikzcuboid{%
217-
% shiftx=25.8cm,%
218-
% shifty=12cm,%
217+
% shiftx=27.1cm,%
218+
% shifty=10.1cm,%
219219
% scale=1.00,%
220220
% rotation=0,%
221-
% densityx=2,%
222-
% densityx=2,%
223-
% densityy=100,%
221+
% densityx=100,%
222+
% densityy=2,%
224223
% densityz=100,%
225-
% dimx=4,%
226-
% dimy=0,%
224+
% dimx=0,%
225+
% dimy=3,%
227226
% dimz=0,%
228227
% emphedge=Y,%
229228
% emphstyle=ultra thick,
230229
% }
230+
% \tikzcuboid{%
231+
% shiftx=27.1cm,%
232+
% shifty=10.1cm,%
233+
% scale=1.00,%
234+
% rotation=180,%
235+
% densityx=100,%
236+
% densityy=100,%
237+
% densityz=2,%
238+
% dimx=0,%
239+
% dimy=0,%
240+
% dimz=3,%
241+
% emphedge=Y,%
242+
% emphstyle=ultra thick,
243+
% }
231244
\tikzcuboid{%
232-
shiftx=25.8cm,%
233-
shifty=11.6cm,%
245+
shiftx=26.8cm,%
246+
shifty=11.4cm,%
234247
scale=1.00,%
235248
rotation=0,%
236249
densityx=100,%
@@ -243,8 +256,8 @@
243256
emphstyle=ultra thick,
244257
}
245258
\tikzcuboid{%
246-
shiftx=25.8cm,%
247-
shifty=11.6cm,%
259+
shiftx=25.3cm,%
260+
shifty=12.9cm,%
248261
scale=1.00,%
249262
rotation=180,%
250263
densityx=100,%
@@ -256,8 +269,9 @@
256269
emphedge=Y,%
257270
emphstyle=ultra thick,
258271
}
259-
\fill (27,11.6) circle[radius=2pt];
260-
\node [font=\bfseries\fontsize{100}{100}\selectfont, anchor=west, text width=8cm] at (29,10.25) {xray};
272+
% \fill (27.1,10.1) circle[radius=2pt];
273+
\node [font=\fontsize{100}{100}\fontfamily{phv}\selectfont, anchor=west, text width=9cm, color=white!50!black] at (30,10.6) {\textbf{\emph{x}}};
274+
\node [font=\fontsize{100}{100}\fontfamily{phv}\selectfont, anchor=west, text width=9cm] at (32,10.25) {{array}};
261275
\end{tikzpicture}
262276

263277
\end{document}

doc/api-hidden.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
.. This extra page is a work around for sphinx not having any support for
33
.. hiding an autosummary table.
44
5-
.. currentmodule:: xray
5+
.. currentmodule:: xarray
66

77
.. autosummary::
88
:toctree: generated/

doc/api.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
.. currentmodule:: xray
1+
.. currentmodule:: xarray
22

33
#############
44
API reference
55
#############
66

7-
This page provides an auto-generated summary of xray's API. For more details
7+
This page provides an auto-generated summary of xarray's API. For more details
88
and examples, refer to the relevant chapters in the main part of the
99
documentation.
1010

@@ -308,7 +308,7 @@ Universal functions
308308
===================
309309

310310
This functions are copied from NumPy, but extended to work on NumPy arrays,
311-
dask arrays and all xray objects. You can find them in the ``xray.ufuncs``
311+
dask arrays and all xarray objects. You can find them in the ``xarray.ufuncs``
312312
module:
313313

314314
:py:attr:`~ufuncs.angle`

0 commit comments

Comments
 (0)