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

Update module headers and installation instructions #3170

Merged
merged 4 commits into from
Oct 2, 2018
Merged

Update module headers and installation instructions #3170

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c53754c
Update module headers and installation instructions
znicholls Sep 16, 2018
b1186b5
Realise that running the tests is simpler than I thought
znicholls Sep 16, 2018
b0fcb4a
Update install instructions for developers
znicholls Sep 17, 2018
ba432a1
Update INSTALL to be consistent
znicholls Oct 1, 2018
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
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
*.py[co]

# Environment file which should be autogenerated
*conda_requirements.txt*

# Packages
*.egg?
*.egg-info
Expand Down
24 changes: 20 additions & 4 deletions INSTALL
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ Installing from source
The latest Iris source release is available from
https://github.com/SciTools/iris.

Iris makes use of a range of other libraries and python modules. These
dependencies must be in place before you can successfully install
Iris makes use of a range of other libraries and python modules. These
dependencies must be in place before you can successfully install
Iris. Once you have satisfied the requirements detailed in the
``requirements`` directory, go to the root of Iris' and run::

Expand All @@ -42,8 +42,8 @@ Iris. Once you have satisfied the requirements detailed in the

In-place build - an alternative for developers
==============================================
We are very keen to encourage contributions to Iris. For this type of
development activity an in-place build can be useful. Once you've cloned
We are very keen to encourage contributions to Iris. For this type of
development activity an in-place build can be useful. Once you've cloned
the Iris git repository you can perform an in-place build with::

pip install -e .
Expand All @@ -66,6 +66,22 @@ Alternatively, a full requirements file that includes all optional dependencies
python requirements/gen_conda_requirements.py --groups all > conda_requirements.txt


Running the tests
'''''''''''''''''

In order to run the tests, you will need to use the `test` and `docs` groups (we include the `docs` group so that you can run the pull request tests locally).
Hence the commands change to::

python requirements/gen_conda_requirements.py --groups test docs > conda_requirements.txt
conda create -n my_iris_env --file conda_requirements.txt
conda activate my_iris_env # or whatever other name you gave it
pip install -e .

The tests can then be run with

python setup.py test


Custom site configuration
=========================
The default site configuration values can be overridden by creating the file
Expand Down