Skip to content

Commit c9be0ea

Browse files
committed
add image of shape editor
1 parent 670ef8c commit c9be0ea

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

docs/source/gui.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -228,8 +228,6 @@ of the configuration. Information about the avilable properties can be found in
228228
Plasma Shape Editor
229229
-------------------
230230

231-
TODO: add images
232-
233231
The Plasma Shape Editor provides an interactive interface for running the
234232
`NICE <https://gitlab.inria.fr/blfauger/nice>`__ (Newton direct and Inverse Computation
235233
for Equilibrium) solver. This allows you to design and analyze plasma equilibria by
@@ -240,6 +238,9 @@ The interface is primarily divided into two sections: a large plotting area on t
240238
that displays the machine geometry and equilibrium results, and a control panel on the
241239
right with various configuration options.
242240

241+
.. figure:: images/gui/plasma_shape_editor.png
242+
243+
Overview of the Plasma Shape Editor
243244

244245
Operating Modes
245246
^^^^^^^^^^^^^^^
@@ -346,4 +347,10 @@ Its behavior changes depending on the operating mode:
346347
in Inverse Mode, the sliders will be updated to show the calculated currents.
347348
* In **Direct Mode**, the sliders for all coils are enabled. You must use these sliders to provide the input current for every coil.
348349

350+
You can save the coil currents to waveforms at a chosen export time.
351+
This allows for a convenient construction of a waveform by iteratively executing the following steps:
352+
353+
#. Configure the plasma parameters and shape.
354+
#. Execute NICE to calculate the set of coil currents.
355+
#. Set an export time value, and append the calculated values to the respective waveforms.
349356

704 KB
Loading

0 commit comments

Comments
 (0)