Require only numpy 1.7 for the benefit of readthedocs #129
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ReadTheDocs comes with pre-built packages for the basic scientific python stack, but some of these packages are old (e.g., numpy is 1.7.1). The only way to upgrade packages on readthedocs is to use a virtual environment and a requirements.txt. Unfortunately, this means we can't upgrade both numpy and pandas simultaneously, because pandas may get built first and link against the wrong version of numpy. We inadvertantly stumbled upon a work around to build the "latest" docs by first installing numpy in the (cached) virtual environment, and then later (in another commit), adding pandas to the requirements.txt file. However, this is a real hack and makes it impossible to maintain different versions of the docs, such as for tagged releases. Accordingly, this commit relaxes the numpy version requirement so we can use a version that readthedocs already has installed. (We actually don't really need a newer version of numpy for any current functionality in xray, although it's nice to have for support for missing value functions like nanmean.)
| install_requires=['numpy >= 1.8', 'pandas >= 0.13.1'], | ||
| tests_require=['mock >= 1.0.1', 'nose >= 1.0'], | ||
| install_requires=['numpy >= 1.7', 'pandas >= 0.13.1'], | ||
| tests_require=['nose >= 1.0'], |
There was a problem hiding this comment.
Note: it turns out we aren't using mock in our tests anymore, so I removed this.
shoyer
added a commit
that referenced
this pull request
May 15, 2014
Require only numpy 1.7 for the benefit of readthedocs
keewis
pushed a commit
to keewis/xarray
that referenced
this pull request
Jan 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
ReadTheDocs comes with pre-built packages for the basic scientific python
stack, but some of these packages are old (e.g., numpy is 1.7.1). The only way
to upgrade packages on readthedocs is to use a virtual environment and a
requirements.txt.
Unfortunately, this means we can't upgrade both numpy and pandas
simultaneously, because pandas may get built first and link against the wrong
version of numpy. We inadvertantly stumbled upon a work around to build the
"latest" docs by first installing numpy in the (cached) virtual environment,
and then later (in another commit), adding pandas to the requirements.txt
file.
However, this is a real hack and makes it impossible to maintain different
versions of the docs, such as for tagged releases. Accordingly, this commit
relaxes the numpy version requirement so we can use a version that readthedocs
already has installed. (We actually don't really need a newer version of numpy
for any current functionality in xray, although it's nice to have for support
for missing value functions like nanmean.)