Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

update the install guide #5066

Merged
merged 5 commits into from
Mar 23, 2021
Merged

update the install guide #5066

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a7ae915
update the min deps
keewis Mar 22, 2021
9395669
update the asv url
keewis Mar 22, 2021
34f13c4
remove the pint warning [skip-ci]
keewis Mar 22, 2021
7a21c82
Update doc/getting-started-guide/installing.rst
keewis Mar 23, 2021
aab925d
remove the links to the xarray asv setup
keewis Mar 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 3 additions & 11 deletions doc/getting-started-guide/installing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ Required dependencies

- Python (3.7 or later)
- setuptools (40.4 or later)
- `numpy <http://www.numpy.org/>`__ (1.15 or later)
- `pandas <http://pandas.pydata.org/>`__ (0.25 or later)
- `numpy <http://www.numpy.org/>`__ (1.17 or later)
- `pandas <http://pandas.pydata.org/>`__ (1.0 or later)

.. _optional-dependencies:

Expand Down Expand Up @@ -77,14 +77,6 @@ Alternative data containers
~~~~~~~~~~~~~~~~~~~~~~~~~~~
- `sparse <https://sparse.pydata.org/>`_: for sparse arrays
- `pint <https://pint.readthedocs.io/>`_: for units of measure

.. note::

At the moment of writing, xarray requires a `highly experimental version of pint
<https://github.com/andrewgsavage/pint/pull/6>`_ (install with
``pip install git+https://github.com/andrewgsavage/pint.git@refs/pull/6/head)``.
Even with it, interaction with non-numpy array libraries, e.g. dask or sparse, is broken.

- Any numpy-like objects that support
`NEP-18 <https://numpy.org/neps/nep-0018-array-function-protocol.html>`_.
Note that while such libraries theoretically should work, they are untested.
Expand Down Expand Up @@ -178,7 +170,7 @@ Performance Monitoring
~~~~~~~~~~~~~~~~~~~~~~

A fixed-point performance monitoring of (a part of) our codes can be seen on
keewis marked this conversation as resolved.
Show resolved Hide resolved
`this page <https://tomaugspurger.github.io/asv-collection/xarray/>`__.
`this page <https://pandas.pydata.org/speed/xarray/>`__.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this still running? I didn't know about it! And it looks like it hasn't run in 18 months?

Copy link
Collaborator Author

@keewis keewis Mar 23, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the last date I could find was 2019-12-13 (about 15 months ago). That's better than the previous link (which is dead), but of course we should only link to something that's working. For reference, I copied this link from the "contributing" guide.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shall we remove for the moment?

I think this was on a recent funding proposal so we'll hopefully have much more here soon...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this was on a recent funding proposal so we'll hopefully have much more here soon...

Yes, the benchmarking work is on the NASA proposal

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I hid both links. Once we have a working setup we can uncomment them again.


To run these benchmark tests in a local machine, first install

Expand Down