Skip to content

Commit 57e8442

Browse files
committed
Update docs for v0.1.1
1 parent 5a165b2 commit 57e8442

File tree

6 files changed

+47
-18
lines changed

6 files changed

+47
-18
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -152,18 +152,15 @@ labeled numpy arrays that provided some guidance for the design of xray.
152152
For more details, see the **[full documentation][docs]**, particularly the
153153
**[tutorial][tutorial]**.
154154

155-
xray requires Python 2.7 and recent versions of [numpy][numpy] (1.8.0 or
156-
later) and [pandas][pandas] (0.13.1 or later). [netCDF4-python][nc4],
155+
xray requires Python 2.7 or 3.3 and recent versions of [numpy][numpy] (1.7.0
156+
or later) and [pandas][pandas] (0.13.1 or later). [netCDF4-python][nc4],
157157
[pydap][pydap] and [scipy][scipy] are optional: they add support for reading
158158
and writing netCDF files and/or accessing OpenDAP datasets.
159159

160160
You can install xray from the pypi with pip:
161161

162162
pip install xray
163163

164-
Python 3 is supported on the current development version (available from
165-
Github).
166-
167164
[docs]: http://xray.readthedocs.org/
168165
[tutorial]: http://xray.readthedocs.org/en/latest/tutorial.html
169166
[numpy]: http://www.numpy.org/
@@ -190,9 +187,13 @@ xray:
190187
to support `Dataset` objects linked to NetCDF or HDF5 files on disk to
191188
allow for incremental writing of data.
192189

190+
If you have questions or comments about any of this, please feel free to raise
191+
a GitHub issue or get in touch via the [mailing list][mailing list].
192+
193193
[blaze]: https://github.com/ContinuumIO/blaze/
194194
[blz]: https://github.com/ContinuumIO/blz
195195
[biggus]: https://github.com/SciTools/biggus
196+
[mailing list]: https://groups.google.com/forum/#!forum/xray-discussion
196197

197198
## About xray
198199

doc/conf.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,11 +87,14 @@ def __getattr__(cls, name):
8787
'sphinx.ext.autodoc',
8888
'sphinx.ext.autosummary',
8989
'sphinx.ext.intersphinx',
90+
'sphinx.ext.extlinks',
9091
'numpydoc',
9192
'IPython.sphinxext.ipython_directive',
9293
'IPython.sphinxext.ipython_console_highlighting',
9394
]
9495

96+
extlinks = {'issue': ('https://github.com/xray/xray/issues/%s', 'GH')}
97+
9598
autosummary_generate = True
9699

97100
numpydoc_class_members_toctree = True

doc/index.rst

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -45,17 +45,17 @@ compatibility with the full `PyData ecosystem <http://pydata.org/>`__.
4545
For a longer introduction to **xray** and its design goals, see
4646
`the project's GitHub page <http://github.com/xray/xray>`__. The GitHub
4747
page is where to go to look at the code, report a bug or make your own
48-
contribution. You can also get in touch via `Twitter
49-
<http://twitter.com/shoyer>`__.
48+
contribution. If you have questions or more general feedback about xray, feel
49+
free to get in touch via `Twitter <http://twitter.com/shoyer>`__ or the
50+
`mailing list <https://groups.google.com/forum/#!forum/xray-discussion>`__.
5051

5152
.. note ::
5253
53-
**xray** is still very new -- it is on its first release and is only a few
54-
months old. Although we will make a best effort to maintain the current
55-
API, it is likely that the API will change in future versions as xray
56-
matures. Some changes are already anticipated, as called out in the
57-
`Tutorial <tutorial>`_ and the project `README
58-
<http://github.com/xray/xray>`__.
54+
**xray** is still very new -- it is only a few months old. Although we will
55+
make a best effort to maintain the current API, it is likely that the API
56+
will change in future versions as xray matures. Some changes are already
57+
anticipated, as called out in the `Tutorial <tutorial>`_ and the project
58+
`README <http://github.com/xray/xray>`__.
5959
6060
Contents
6161
--------
@@ -67,3 +67,4 @@ Contents
6767
tutorial
6868
data-structures
6969
api
70+
whats_new

doc/installing.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
Installing xray
22
===============
33

4-
xray requires Python 2.7 and recent versions of
5-
`numpy <http://www.numpy.org/>`__ (1.8.0 or later) and
4+
xray runs on Python 2.7 and Python 3.3 (Python 3.4 has not yet been tested).
5+
It also requires
6+
`numpy <http://www.numpy.org/>`__ (1.7 or later) and
67
`pandas <http://pandas.pydata.org/>`__ (0.13.1 or later).
78
`netCDF4-python <https://github.com/Unidata/netcdf4-python>`__,
89
`pydap <http://www.pydap.org/>`__ and `scipy <http://scipy.org/>`__ are

doc/whats_new.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
What's New
2+
==========
3+
4+
v0.1.1 (20 May 2014)
5+
--------------------
6+
7+
xray 0.1.1 is a bug-fix release that includes changes that should be almost
8+
entirely backwards compatible with v0.1:
9+
10+
- Python 3 support (:issue:`53`)
11+
- Required numpy version relaxed to 1.7 (:issue:`129`)
12+
- Return numpy.datetime64 arrays for non-standard calendars (:issue:`126`)
13+
- Support for opening datasets associated with NetCDF4 groups (:issue:`127`)
14+
- Bug-fixes for concatenating datetime arrays (:issue:`134`)
15+
16+
Special thanks to new contributors Thomas Kluyver, Joe Hamman and Alistair
17+
Miles.
18+
19+
v0.1 (2 May 2014)
20+
-----------------
21+
22+
Initial release.

setup.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
from distutils.core import setup
1010

1111
MAJOR = 0
12-
MINOR = 2
13-
MICRO = 0
12+
MINOR = 1
13+
MICRO = 1
1414
ISRELEASED = False
1515
VERSION = '%d.%d.%d' % (MAJOR, MINOR, MICRO)
1616
QUALIFIER = ''
@@ -19,14 +19,15 @@
1919
DISTNAME = 'xray'
2020
LICENSE = 'Apache'
2121
AUTHOR = 'Stephan Hoyer, Alex Kleeman, Eugene Brevdo'
22-
AUTHOR_EMAIL = 'shoyer@climate.com'
22+
AUTHOR_EMAIL = 'xray-discussion@googlegroups.com'
2323
URL = 'https://github.com/xray/xray'
2424
CLASSIFIERS = [
2525
'Development Status :: 3 - Alpha',
2626
'License :: OSI Approved :: Apache Software License',
2727
'Operating System :: OS Independent',
2828
'Intended Audience :: Science/Research',
2929
'Programming Language :: Python :: 2.7',
30+
'Programming Language :: Python :: 3.3',
3031
'Topic :: Scientific/Engineering',
3132
]
3233

0 commit comments

Comments
 (0)