-
Notifications
You must be signed in to change notification settings - Fork 300
Updated Iris install instructions #3817
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
3f8b64a
Updated the Iris install instructions
tkknight d6bbaf1
Renamed section titles and reworded paragraph.
tkknight 9721f73
Improved paragraph wording
tkknight 7b2feb2
Removed references to INSTALL
tkknight 72d2665
Merge branch 'master' into docs_requirements_conda
tkknight 8529ced
Merge branch 'master' into docs_requirements_conda
tkknight d1cc555
Merge branch 'master' into docs_requirements_conda
tkknight File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,97 @@ | ||
| .. _installing_iris: | ||
|
|
||
| Installing Iris | ||
| *************** | ||
| =============== | ||
|
|
||
| .. include:: ../../../INSTALL | ||
| Iris is available using conda for the following platforms: | ||
|
|
||
| * Linux 64-bit, | ||
| * Mac OSX 64-bit, and | ||
| * Windows 64-bit. | ||
|
|
||
| .. note:: Iris currently supports and is tested against **Python 3.6** and | ||
| **Python 3.7**. | ||
|
|
||
|
|
||
| .. _installing_using_conda: | ||
|
|
||
| Installing using conda (users) | ||
| ------------------------------ | ||
|
|
||
| To install Iris using conda, you must first download and install conda, | ||
| for example from https://docs.conda.io/en/latest/miniconda.html. | ||
|
|
||
| Once conda is installed, you can install Iris using conda with the following | ||
| command:: | ||
|
|
||
| conda install -c conda-forge iris | ||
|
|
||
| If you wish to run any of the code in the gallery you will also | ||
| need the Iris sample data. This can also be installed using conda:: | ||
|
|
||
| conda install -c conda-forge iris-sample-data | ||
|
|
||
| Further documentation on using conda and the features it provides can be found | ||
| at https://conda.io/en/latest/index.html. | ||
|
|
||
|
|
||
| .. _installing_from_source: | ||
|
|
||
| Installing from source (devs) | ||
| ----------------------------- | ||
|
|
||
| The latest Iris source release is available from | ||
| https://github.com/SciTools/iris. | ||
|
|
||
| For instructions on how to obtain the Iris project source from GitHub see | ||
| :ref:`forking` and :ref:`set-up-fork` for instructions. | ||
|
|
||
| Once conda is installed, you can install Iris using conda and then activate | ||
| it. The example commands below assume you are in the root directory of your | ||
| local copy of Iris:: | ||
|
|
||
| conda env create --file=requirements/ci/iris.yml | ||
| conda activate iris-dev | ||
|
|
||
| The ``requirements/ci/iris.yml`` file defines the Iris development conda | ||
| environment *name* and all the relevant *top level* `conda-forge` package | ||
| dependencies that you need to **code**, **test**, and **build** the | ||
| documentation. If you wish to minimise the environment footprint, simply | ||
| remove any unwanted packages from the requirements file e.g., if you don't | ||
| intend to run the Iris tests locally or build the documentation, then remove | ||
| all the packages from the `testing` and `documentation` sections. | ||
|
|
||
| .. note:: The ``requirements/ci/iris.yml`` file will always use the latest | ||
| Iris tested Python version available. For all Python versions that | ||
| are supported and tested against by Iris, view the contents of | ||
| the `requirements/ci`_ directory. | ||
|
|
||
| .. _requirements/ci: https://github.com/scitools/iris/tree/master/requirements/ci | ||
|
|
||
| Finally you need to run the command to configure your shell environment | ||
| to find your local Iris code:: | ||
|
|
||
| python setup.py develop | ||
|
|
||
|
|
||
| Running the tests | ||
| ----------------- | ||
|
|
||
| To ensure your setup is configured correctly you can run the test suite using | ||
| the command:: | ||
|
|
||
| python setup.py test | ||
|
|
||
|
|
||
| Custom site configuration | ||
| ------------------------- | ||
|
|
||
| The default site configuration values can be overridden by creating the file | ||
| ``iris/etc/site.cfg``. For example, the following snippet can be used to | ||
| specify a non-standard location for your dot executable:: | ||
|
|
||
| [System] | ||
| dot_path = /usr/bin/dot | ||
|
|
||
| An example configuration file is available in ``iris/etc/site.cfg.template``. | ||
| See :py:func:`iris.config` for further configuration options. | ||
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.
Uh oh!
There was an error while loading. Please reload this page.