Skip to content

Commit 8441cad

Browse files
committed
Add link to usage per code
1 parent 18e963d commit 8441cad

File tree

7 files changed

+15
-7
lines changed

7 files changed

+15
-7
lines changed

Docs/source/install/artemis.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,9 @@ Both methods produce an executable ready for simulation. By default, the Landau-
9090
Build Verification
9191
^^^^^^^^^^^^^^^^^^
9292

93-
After successful compilation, verify the build by checking the executable exists and can display help information. The executable will be located in the build directory or top directory depending on your build method.
93+
After successful compilation, verify the build by running a test simulation. The executable will be located in the build directory or top directory depending on your build method.
94+
95+
For detailed instructions on setting up and running ARTEMIS simulations, see :ref:`usage_run_artemis`.
9496

9597
Advanced Build Options
9698
-----------------------

Docs/source/install/eleqtroneX.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,9 @@ For CMake builds:
9393
Build Verification
9494
^^^^^^^^^^^^^^^^^^
9595

96-
After successful compilation, verify the build by checking that the executable was created and can display help information. Also ensure any required preprocessor flags in ``Source/Code_Definitions.H`` are properly configured for your simulation needs.
96+
After successful compilation, verify the build by running a test simulation. Also ensure any required preprocessor flags in ``Source/Code_Definitions.H`` are properly configured for your simulation needs.
97+
98+
For detailed instructions on setting up and running ELEQTRONeX simulations, see :ref:`usage_run_eleqtronex`.
9799

98100
Advanced Build Options
99101
-----------------------

Docs/source/install/ferrox.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,9 @@ Navigate to the FerroX/Exec directory and build using your preferred method:
8383
Build Verification
8484
^^^^^^^^^^^^^^^^^^
8585

86-
After successful compilation, verify the installation by running the test cases provided in the Examples directory. Check that the executable runs without errors and produces expected output files.
86+
After successful compilation, verify the installation by running a test simulation from the Examples directory.
87+
88+
For detailed instructions on setting up and running FerroX simulations, see :ref:`usage_run_ferrox`.
8789

8890
Advanced Build Options
8991
----------------------

Docs/source/install/magnex.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,9 @@ For CMake builds (alternative approach):
9090
Build Verification
9191
^^^^^^^^^^^^^^^^^^
9292

93-
After successful compilation, verify the installation by running the test suite or example problems included in the MagneX distribution.
93+
After successful compilation, verify the installation by running a test simulation from the included example problems.
94+
95+
For detailed instructions on setting up and running MagneX simulations, see :ref:`usage_run_magnex`.
9496

9597
Advanced Build Options
9698
-----------------------

Docs/source/usage/run_eleqtronex.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _usage_run:
1+
.. _usage_run_eleqtronex:
22

33
Run ELEQTRONeX
44
=========

Docs/source/usage/run_ferrox.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _usage_run:
1+
.. _usage_run_ferrox:
22

33
Run FerroX
44
=========

Docs/source/usage/run_magnex.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _usage_run:
1+
.. _usage_run_magnex:
22

33
Run MagneX
44
=========

0 commit comments

Comments
 (0)