diff --git a/docs/src/installing.rst b/docs/src/installing.rst index 1bea781e5a..e26442683e 100644 --- a/docs/src/installing.rst +++ b/docs/src/installing.rst @@ -17,7 +17,7 @@ any WSL_ distributions. .. _WSL: https://docs.microsoft.com/en-us/windows/wsl/install-win10 .. note:: Iris is currently supported and tested against |python_support|. - + .. note:: This documentation was built using Python |python_version|. @@ -92,9 +92,14 @@ 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 env create --force --file=requirements/ci/iris.yml conda activate iris-dev +The ``--force`` option is used when creating the environment, this is optional +and will force the any existing ``iris-dev`` conda environment to be deleted +first if present. This is useful when rebuilding your environment due to a +change in requirements. + 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 diff --git a/docs/src/whatsnew/latest.rst b/docs/src/whatsnew/latest.rst index 8d227eae99..509b9a745f 100644 --- a/docs/src/whatsnew/latest.rst +++ b/docs/src/whatsnew/latest.rst @@ -129,6 +129,11 @@ This document explains the changes made to Iris for this release they render better in the published documentation. See :issue:`4085`. (:pull:`4100`) +#. `@tkknight`_ documented the ``--force`` command line option when creating + a conda development environment. See :ref:`installing_from_source`. + (:pull:`4240`) + + 💼 Internal ===========