diff options
author | Ralf Gommers <ralf.gommers@gmail.com> | 2021-03-21 20:29:19 +0100 |
---|---|---|
committer | Ralf Gommers <ralf.gommers@gmail.com> | 2021-03-21 20:29:19 +0100 |
commit | 4f5be827dbdbe5337845a5dea1bd9342a5eeba60 (patch) | |
tree | 6f24857bccfda0347605b575b1c3288836975858 /doc/source/dev/development_environment.rst | |
parent | 326a447e2997918975aa8cb2578ea13855497b76 (diff) | |
download | numpy-4f5be827dbdbe5337845a5dea1bd9342a5eeba60.tar.gz |
DOC: update development environment docs for conda virtual environments
Diffstat (limited to 'doc/source/dev/development_environment.rst')
-rw-r--r-- | doc/source/dev/development_environment.rst | 23 |
1 files changed, 17 insertions, 6 deletions
diff --git a/doc/source/dev/development_environment.rst b/doc/source/dev/development_environment.rst index fb1b8cd6a..665198c69 100644 --- a/doc/source/dev/development_environment.rst +++ b/doc/source/dev/development_environment.rst @@ -57,7 +57,8 @@ When using pytest as a target (the default), you can Using ``runtests.py`` is the recommended approach to running tests. There are also a number of alternatives to it, for example in-place -build or installing to a virtualenv. See the FAQ below for details. +build or installing to a virtualenv or a conda environment. See the FAQ below +for details. .. note:: @@ -130,17 +131,27 @@ to see this output, you can run the ``build_src`` stage verbosely:: $ python build build_src -v -Using virtualenvs ------------------ +Using virtual environments +-------------------------- A frequently asked question is "How do I set up a development version of NumPy in parallel to a released version that I use to do my job/research?". One simple way to achieve this is to install the released version in -site-packages, by using a binary installer or pip for example, and set -up the development version in a virtualenv. First install +site-packages, by using pip or conda for example, and set +up the development version in a virtual environment. + +If you use conda, we recommend creating a separate virtual environment for +numpy development using the ``environment.yml`` file in the root of the repo +(this will create the environment and install all development dependencies at +once):: + + $ conda env create -f environment.yml # `mamba` works too for this command + $ conda activate numpy-dev + +If you installed Python some other way than conda, first install `virtualenv`_ (optionally use `virtualenvwrapper`_), then create your -virtualenv (named numpy-dev here) with:: +virtualenv (named ``numpy-dev`` here) with:: $ virtualenv numpy-dev |