From c53754cff352359db5428ab97f2f021c93e60130 Mon Sep 17 00:00:00 2001 From: Zebedee Nicholls Date: Sun, 16 Sep 2018 21:39:03 +0200 Subject: [PATCH 1/4] Update module headers and installation instructions --- .gitignore | 3 +++ INSTALL | 19 +++++++++++++++---- 2 files changed, 18 insertions(+), 4 deletions(-) diff --git a/.gitignore b/.gitignore index 4a65981ad5..f0420cbc22 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,8 @@ *.py[co] +# Environment file which should be autogenerated +*conda_requirements.txt* + # Packages *.egg? *.egg-info diff --git a/INSTALL b/INSTALL index 3ae4855e25..3bd1aed740 100644 --- a/INSTALL +++ b/INSTALL @@ -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:: @@ -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 . @@ -65,6 +65,17 @@ 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 install a few more modules. These should be installed in your development environment with:: + + conda activate my_iris_env # or whatever other name you gave it + conda install -y nose filelock imagehash mock pep8 + +The tests can then be run with + + python -m iris.tests.runner --default-tests Custom site configuration ========================= From b1186b5c04261dc1eee6680130ee784e3222eafa Mon Sep 17 00:00:00 2001 From: Zebedee Nicholls Date: Sun, 16 Sep 2018 22:03:21 +0200 Subject: [PATCH 2/4] Realise that running the tests is simpler than I thought --- INSTALL | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/INSTALL b/INSTALL index 3bd1aed740..2c19e72ff1 100644 --- a/INSTALL +++ b/INSTALL @@ -68,14 +68,17 @@ Alternatively, a full requirements file that includes all optional dependencies Running the tests ''''''''''''''''' -In order to run the tests, you will need to install a few more modules. These should be installed in your development environment with:: +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 - conda install -y nose filelock imagehash mock pep8 + python setup.py develop The tests can then be run with - python -m iris.tests.runner --default-tests + python setup.py test Custom site configuration ========================= From b0fcb4a414b6ebc1cdb4bf2773231b372302e9d1 Mon Sep 17 00:00:00 2001 From: Zebedee Nicholls Date: Mon, 17 Sep 2018 11:13:58 +0200 Subject: [PATCH 3/4] Update install instructions for developers --- INSTALL | 2 ++ 1 file changed, 2 insertions(+) diff --git a/INSTALL b/INSTALL index 2c19e72ff1..2ba4c7f162 100644 --- a/INSTALL +++ b/INSTALL @@ -65,6 +65,7 @@ Alternatively, a full requirements file that includes all optional dependencies python requirements/gen_conda_requirements.py --groups all > conda_requirements.txt + Running the tests ''''''''''''''''' @@ -80,6 +81,7 @@ 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 From ba432a13a29b831165fde6b3dd821d22524b14e1 Mon Sep 17 00:00:00 2001 From: Zebedee Nicholls Date: Mon, 1 Oct 2018 16:56:06 +0200 Subject: [PATCH 4/4] Update INSTALL to be consistent --- INSTALL | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/INSTALL b/INSTALL index 2ba4c7f162..c8a61769fe 100644 --- a/INSTALL +++ b/INSTALL @@ -75,7 +75,7 @@ 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 - python setup.py develop + pip install -e . The tests can then be run with