Skip to content

Commit 2f57d8b

Browse files
committed
clarify docs
1 parent 5da0db0 commit 2f57d8b

File tree

3 files changed

+8
-16
lines changed

3 files changed

+8
-16
lines changed

docs/source/gui.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,9 @@ This is where you set up the core parameters for NICE and provide the necessary
290290
This section includes settings for:
291291

292292
* The file paths to the NICE executables for both *inverse* and *direct* modes.
293-
These correspond to the executables that were built in :ref:`this section <installing_nice>`. For example:
293+
If you are using the NICE module, you can leave these as their default values:
294+
``nice_imas_inv_muscle3`` and ``nice_imas_dir_muscle3``.
295+
If you manually built NICE, these should point to the executables that were built in :ref:`this section <installing_nice>`. For example:
294296
``path/to/nice/run/nice_imas_inv_muscle3`` and ``path/to/nice/run/nice_imas_dir_muscle3``
295297
for the inverse mode and direct mode executable paths respectively.
296298
* Any environment variables that NICE requires. These are stored as a dictionary of strings.

docs/source/installing.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@ This will download and install the package along with all its required dependenc
1616
1717
pip install waveform-editor
1818
19-
20-
19+
.. _install_nice:
2120

2221
Installing dependencies for the Plasma Shape Editor
2322
---------------------------------------------------

docs/source/training/training.rst

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -603,17 +603,7 @@ Plasma Shape Editor
603603
-------------------
604604

605605
In this section you will learn how to use the plasma shape editor. For this section
606-
it is required to have installed the :ref:`dependencies for the Plasma Shape Editor <shape_editor_install>`.
607-
If you have already built NICE inverse before (for example, if you followed the PDS training),
608-
you can use this instead.
609-
610-
Detailed information about the plasma shape editor can be found in :ref:`the documentation <plasma_shape_editor>`.
611-
If you are on SDCC, ensure the following modules are loaded, which are required to run NICE.
612-
613-
614-
.. code-block:: bash
615-
616-
module load IMAS-Python SuiteSparse/7.7.0-intel-2023b libxml2 Blitz++ MUSCLE3
606+
it is required to have installed the :ref:`dependencies for the Plasma Shape Editor <install_nice>`.
617607

618608
Exercise 6a: Setting up NICE
619609
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -629,8 +619,9 @@ this plasma shape.
629619
You should see an empty plotting window on your left, and an options panel on your right.
630620
NICE requires configuration to be set.
631621

632-
1. Set the executable paths for the NICE inverse and direct mode. These should point
633-
to the executables you built in the :ref:`installation instructions <shape_editor_install>`.
622+
1. Set the executable paths for the NICE inverse and direct mode.
623+
If you are using the NICE module, you can leave these at their default value.
624+
If you manually compiled NICE, you must provide the paths to the executables you built in the :ref:`installation instructions <shape_editor_install>`.
634625
2. Set any NICE environment variables required to run NICE. This depends on your specific system.
635626
If you are on SDCC, you can leave this as is.
636627

0 commit comments

Comments
 (0)