1
- xray : N-D labeled arrays and datasets
2
- =====================================
1
+ xarray : N-D labeled arrays and datasets
2
+ =======================================
3
3
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
7
7
: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 /
14
14
.. image :: https://badges.gitter.im/Join%20Chat.svg
15
- :target: https://gitter.im/xray/xray
15
+ :target: https://gitter.im/pydata/xarray
16
16
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
18
18
labeled data power of pandas _ to the physical sciences, by providing
19
19
N-dimensional variants of the core pandas data structures.
20
20
21
21
Our goal is to provide a pandas-like and pandas-compatible toolkit for
22
22
analytics on multi-dimensional arrays, rather than the tabular data for which
23
23
pandas excels. Our approach adopts the `Common Data Model `_ for self-
24
24
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.
26
26
27
27
.. _pandas : http://pandas.pydata.org
28
28
.. _Common Data Model : http://www.unidata.ucar.edu/software/thredds/current/netcdf-java/CDM
29
29
.. _netCDF : http://www.unidata.ucar.edu/software/netcdf
30
30
.. _OPeNDAP : http://www.opendap.org/
31
31
32
- Why xray ?
33
- ---------
32
+ Why xarray ?
33
+ -----------
34
34
35
35
Adding dimensions names and coordinate indexes to numpy's ndarray _ makes many
36
36
powerful array operations possible:
@@ -43,7 +43,7 @@ powerful array operations possible:
43
43
- Flexible split-apply-combine operations with groupby:
44
44
``x.groupby('time.dayofyear').mean() ``.
45
45
- 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') ``.
47
47
- Keep track of arbitrary metadata in the form of a Python dictionary:
48
48
``x.attrs ``.
49
49
@@ -55,19 +55,19 @@ Why isn't pandas enough?
55
55
56
56
pandas _ excels at working with tabular data. That suffices for many statistical
57
57
analyses, but physical scientists rely on N-dimensional arrays -- which is
58
- where xray comes in.
58
+ where xarray comes in.
59
59
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
61
61
designed for working with homogeneous N-dimensional arrays
62
62
instead of tabular data. When possible, we copy the pandas API and rely on
63
63
pandas's highly optimized internals (in particular, for fast indexing).
64
64
65
65
Why netCDF?
66
66
-----------
67
67
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 ``
71
71
or a pandas ``DataFrame `` or ``Series ``, providing compatibility with the full
72
72
`PyData ecosystem <http://pydata.org/ >`__.
73
73
@@ -82,28 +82,28 @@ especially geoscientists who already know and love netCDF_.
82
82
Documentation
83
83
-------------
84
84
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/
86
86
87
87
Get in touch
88
88
------------
89
89
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
93
92
94
93
History
95
94
-------
96
95
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.
100
100
101
101
__ http://climate.com/
102
102
103
103
License
104
104
-------
105
105
106
- Copyright 2014, xray Developers
106
+ Copyright 2014-2016, xarray Developers
107
107
108
108
Licensed under the Apache License, Version 2.0 (the "License");
109
109
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.
117
117
See the License for the specific language governing permissions and
118
118
limitations under the License.
119
119
120
- xray includes portions of pandas, NumPy and Seaborn. Their licenses are
120
+ xarray includes portions of pandas, NumPy and Seaborn. Their licenses are
121
121
included in the licenses directory.
0 commit comments