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

Jump to bottom

DOC: better explanations of conda env names in install docs #6747

Merged
merged 1 commit into from
Sep 10, 2019
Merged

DOC: better explanations of conda env names in install docs #6747

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 4 additions & 2 deletions doc/install/advanced.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,11 +72,13 @@ from the stable version of MNE-Python to the current development version.
.. warning:: In between releases, function and class APIs can change without
warning.

For a one-time update to latest master, make sure you're in the ``mne`` conda
environment (``conda activate mne``), and use ``pip``:
For a one-time update to latest master, make sure you're in the conda
environment where MNE-Python is installed (if you followed the default install
instructions, this will be ``base``), and use ``pip`` to upgrade:

.. code-block:: console
$ conda activate name_of_my_mne_environment
$ pip install --upgrade --no-deps git+https://github.com/mne-tools/mne-python.git
If you plan to contribute to MNE-Python, or just prefer to use git rather than
Expand Down
23 changes: 15 additions & 8 deletions doc/install/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,14 +137,21 @@ versions of MNE-Python (so you can, for example, use the same computer to
analyze your data with the stable release, and also work with the latest
development version to fix bugs or add new features). If you've already
followed the :ref:`installation instructions <install-python>` for the stable
version of MNE-Python, after this you'll end up with two environments: ``mne``
(stable version) and ``mnedev`` (development version).

Once you have a working Python environment, the first step is to `clone`_ the
MNE-Python repository from your remote fork, and also connect the local copy to
the ``upstream`` version of the codebase, so you can stay up-to-date with
changes from other contributors. First, edit these two variables for your
situation::
version of MNE-Python, MNE-Python will be installed in the environment ``base``
(unless you provided a custom environment name during installation). Before
continuing, you should create a new, separate environment for MNE-Python
development (here we'll call it ``mnedev``):

$ curl --remote-name https://github.com/raw/mne-tools/mne-python/master/environment.yml
$ conda env create --file environment.yml --name mnedev
$ conda activate mnedev

Now you'll have *two* MNE-Python environments: ``base`` (or whatever you called
it) for the stable version and ``mnedev`` for the development version. Next
`clone`_ the MNE-Python repository from your remote fork, and also connect the
local copy to the ``upstream`` version of the codebase, so you can stay
up-to-date with changes from other contributors. First, edit these two
variables for your situation::

$ INSTALL_LOCATION="/opt"
$ GITHUB_USERNAME="new_mne_contributor"
Expand Down