Skip to content

Updated MSlice quickstart guide to reflect it as an optional dependancy of conda installs #1096

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

Merged
merged 1 commit into from
Jul 17, 2025
Merged

Updated MSlice quickstart guide to reflect it as an optional dependancy of conda installs #1096

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
8 changes: 4 additions & 4 deletions docs/source/quickstart.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ MSlice is included in the Mantid distribution so the easiest way to start it is

.. image:: images/quickstart/mantid_interfaces_menu.png

The version of *MSlice* distributed with Mantid is the last stable version. Starting with *MantidWorkbench* version 6.12, MSlice is
included as a conda package within *MantidWorkbench*. This enables users to replace the MSlice version within the conda environment
where *MantidWorkbench* is set up.
The version of *MSlice* distributed with Mantid is the last stable version. For conda installs starting from *MantidWorkbench* version 6.14, MSlice is
made an optional dependency of *MantidWorkbench*. This enables users to selectively install the MSlice version within the conda environment
where *MantidWorkbench* is set up. For standalone installs of *MantidWorkbench*, the last stable version of MSlice is included.
For versions of *MantidWorkbench* prior to 6.12., it is possible to replace MSlice with the latest development version on `GitHub`.
To get this version, please download this `zip <https://github.com/mantidproject/mslice/archive/main.zip>`_ and extract it to a
folder on your computer. You can then copy the ``mslice`` subfolder (the folder containing a file called ``__init__.py``) to the
``scripts/ExternalInterfaces/`` folder of *Mantid*, which will make the new version accessible from *MantidWorkbench*.

Alternatively, Mslice is available as a conda package via anaconda.org on the `mantid channel <https://anaconda.org/mantid/mslice>`_.
Alternatively, MSlice is available as a conda package via anaconda.org on the `mantid channel <https://anaconda.org/mantid/mslice>`_.
To install the released conda package do ``mamba install -c mantid mslice``.
To install the latest nightly conda package do ``mamba install -c mantid/label/nightly mslice``. The nightly conda package includes
all recent changes of the development version up to and including the day before and is only created when all tests have run
Expand Down
Loading