Skip to content

Commit

Permalink
Adjusted README to note that we require Python 2.7
Browse files Browse the repository at this point in the history
Also adjusted setup.py slightly.
  • Loading branch information
shoyer committed Apr 2, 2014
1 parent 4eef8ec commit 1e78dcb
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 7 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ Adding dimensions names and coordinate values to numpy's [ndarray][ndarray]
makes many powerful array operations easy:

- Apply operations over dimensions by name: `x.sum('time')`.
- Select values by label instead of integer location: `x.loc['2014-01-01']`.
- Select values by label instead of integer location: `x.loc['2014-01-01']`
or `x.labeled_by(time='2014-01-01')`.
- Mathematical operations (e.g., `x - y`) vectorize across multiple
dimensions (known in numpy as "broadcasting") based on dimension names,
regardless of their original order.
Expand Down Expand Up @@ -155,9 +156,12 @@ For more details, see the **[full documentation][docs]** (still a work in
progress) or the source code. **xray** is rapidly maturing, but it is still in
its early development phase. ***Expect the API to change.***

At present, it requires the python dependencies numpy 1.8.0, scipy 0.13,
pandas 0.13.1 and netCDF4 1.0.6. The easiest way to get these installed from
scratch is to use [Anaconda][anaconda].
xray currently requires Python 2.7 and the python libraries `numpy>=1.8.0`,
`scipy>=0.13`, `pandas>=0.13.1` and `netCDF4>=1.0.6`. The easiest way to get
these installed from scratch is to use [Anaconda][anaconda]. Eventually these
requirements will be relaxed: python libraries (other than numpy and pandas)
will be required only for the relevant functionality, and we will support
Python 3.

It is not yet available on the Python package index (prior to its initial
release). For now, you need to install it from source:
Expand Down
6 changes: 3 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -84,12 +84,12 @@ def write_version_py(filename=None):

setup(name='xray',
version=FULLVERSION,
description='Objects for holding self describing scientific data in python',
description='Extended arrays for working with scientific datasets',
author='Stephan Hoyer, Alex Kleeman, Eugene Brevdo',
author_email='TODO',
install_requires=['scipy >= 0.13', 'numpy >= 1.8', 'netCDF4 >= 1.0.6',
'pandas >= 0.13.1', 'mock >= 1.0.1'],
tests_require=['nose >= 1.0'],
'pandas >= 0.13.1'],
tests_require=['mock >= 1.0.1', 'nose >= 1.0'],
url='https://github.com/akleeman/xray',
test_suite='nose.collector',
packages=['xray'],
Expand Down

0 comments on commit 1e78dcb

Please sign in to comment.