Skip to content

Commit 83ef3ff

Browse files
committed
clarify docs
1 parent bfe086b commit 83ef3ff

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

docs/source/gui.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,11 @@ This is where you set up the core parameters for NICE and provide the necessary
282282
This section includes settings for:
283283

284284
* The file paths to the NICE executables for both *inverse* and *direct* modes.
285-
* Any environment variables that NICE requires.
285+
These correspond to the executables that were built in :ref:`this section <installing_nice>`. For example:
286+
``path/to/nice/run/nice_imas_inv_muscle3`` and ``path/to/nice/run/nice_imas_dir_muscle3``
287+
for the inverse mode and direct mode executable paths respectively.
288+
* Any environment variables that NICE requires. These are stored as a dictionary of strings.
289+
For example: ``{'LD_LIBRARY_PATH': '/home/user/.local/lib'}``
286290
* The IMAS URIs for the machine descriptions.
287291
* The level of detail in the output logs generated by the solver.
288292

docs/source/shape_editor_install.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,10 @@ Installing dependencies
7171
export LD_LIBRARY_PATH=~/.local/lib:$LD_LIBRARY_PATH
7272
7373
74-
Building the NICE inverse MUSCLE3 IMAS program
75-
----------------------------------------------
74+
.. _installing_nice:
75+
76+
Building the NICE MUSCLE3 IMAS program
77+
--------------------------------------
7678

7779
The following instructions are adapted from
7880
https://blfauger.gitlabpages.inria.fr/nice/install.html.

0 commit comments

Comments
 (0)