Skip to content

Commit

Permalink
deploy: 4ae43f8
Browse files Browse the repository at this point in the history
  • Loading branch information
SilkeSchomann committed Nov 15, 2024
1 parent d91f86f commit de4d9e1
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 9 deletions.
Binary file modified .doctrees/environment.pickle
Binary file not shown.
Binary file modified .doctrees/quickstart.doctree
Binary file not shown.
10 changes: 6 additions & 4 deletions _sources/quickstart.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,12 @@ 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. However, there is currently quite rapid ongoing
development to the program, which is available in the 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
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.
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>`_.
Expand Down
10 changes: 6 additions & 4 deletions quickstart.html
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,12 @@ <h1><span class="section-number">1. </span>Quick Start<a class="headerlink" href
<h2><span class="section-number">1.1. </span>Starting MSlice<a class="headerlink" href="#starting-mslice" title="Link to this heading"></a></h2>
<p>MSlice is included in the Mantid distribution so the easiest way to start it is from the <strong>Interfaces</strong> menu in <em>MantidWorkbench</em>.</p>
<img alt="_images/mantid_interfaces_menu.png" src="_images/mantid_interfaces_menu.png" />
<p>The version of <em>MSlice</em> distributed with Mantid is the last stable version. However, there is currently quite rapid ongoing
development to the program, which is available in the development version on <cite>GitHub</cite>. To get this version, please
download this <a class="reference external" href="https://github.com/mantidproject/mslice/archive/main.zip">zip</a> and extract it to a folder on your computer.
You can then copy the <code class="docutils literal notranslate"><span class="pre">mslice</span></code> subfolder (the folder containing a file called <code class="docutils literal notranslate"><span class="pre">__init__.py</span></code>) to the
<p>The version of <em>MSlice</em> distributed with Mantid is the last stable version. Starting with <em>MantidWorkbench</em> version 6.12, MSlice is
included as a conda package within <em>MantidWorkbench</em>. This enables users to replace the MSlice version within the conda environment
where <em>MantidWorkbench</em> is set up.
For versions of <em>MantidWorkbench</em> prior to 6.12., it is possible to replace MSlice with the latest development version on <cite>GitHub</cite>.
To get this version, please download this <a class="reference external" href="https://github.com/mantidproject/mslice/archive/main.zip">zip</a> and extract it to a
folder on your computer. You can then copy the <code class="docutils literal notranslate"><span class="pre">mslice</span></code> subfolder (the folder containing a file called <code class="docutils literal notranslate"><span class="pre">__init__.py</span></code>) to the
<code class="docutils literal notranslate"><span class="pre">scripts/ExternalInterfaces/</span></code> folder of <em>Mantid</em>, which will make the new version accessible from <em>MantidWorkbench</em>.</p>
<p>Alternatively, Mslice is available as a conda package via anaconda.org on the <a class="reference external" href="https://anaconda.org/mantid/mslice">mantid channel</a>.
To install the released conda package do <code class="docutils literal notranslate"><span class="pre">mamba</span> <span class="pre">install</span> <span class="pre">-c</span> <span class="pre">mantid</span> <span class="pre">mslice</span></code>.
Expand Down
Loading

0 comments on commit de4d9e1

Please sign in to comment.