Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc: Fix RST Syntax #835

Merged
merged 5 commits into from
Feb 9, 2025
Merged

Doc: Fix RST Syntax #835

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c4f57db
Doc: Fix RST Syntax
ax3l Feb 8, 2025
0e02bf0
Elements: Sub-Headings
ax3l Feb 8, 2025
c93f89f
Sort Elements Alphabetically
ax3l Feb 8, 2025
c36f667
Update add_element.rst
ax3l Feb 9, 2025
c8631bd
Update add_element.rst
ax3l Feb 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/source/install/hpc/lumi.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ Use the following :ref:`cmake commands <building-cmake>` to compile the applicat
cmake --fresh -S . -B build_lumi_cpu_py -DImpactX_FFT=ON -DImpactX_PYTHON=ON
cmake --build build_lumi_cpu_py -j 16 --target pip_install

Now, you can :ref:`submit LUMI compute jobs <running-cpp-lumi>` for ImpactX :ref:`Python scripts <usage-picmi>` (:ref:`example scripts <usage-examples>`).
Now, you can :ref:`submit LUMI compute jobs <running-cpp-lumi>` for ImpactX :ref:`Python scripts <usage_run-user-interface>` (:ref:`example scripts <usage-examples>`).
Or, you can use the ImpactX executables to submit LUMI jobs (:ref:`example inputs <usage-examples>`).
For executables, you can reference their location in your :ref:`job script <running-cpp-lumi>` or copy them to a location in ``/project/$proj`` or ``/scratch/$proj``.

Expand Down
12 changes: 10 additions & 2 deletions docs/source/usage/how_to_run.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ Run ImpactX
===========


.. _usage_run-tracking-mode:

How to select a tracking mode
-----------------------------

Expand All @@ -20,6 +22,8 @@ Reference Tracking Early Design Reference orbit No
================== =============== =============== ==================


.. _usage_run-user-interface:

How to select a user interface
------------------------------

Expand All @@ -40,6 +44,8 @@ Dashboard Beginner Learning, Control-Systems Yes No
=========== ================= ========================= =========== =========== ============== ===========


.. _usage_run-user-interface-how:

How to run
----------

Expand All @@ -66,6 +72,8 @@ After installing ImpactX, run :ref:`one of our examples <usage-examples>`, e.g.,
impactx-dashboard


.. _usage_run-computing-system:

How to select a computing system
--------------------------------

Expand All @@ -86,6 +94,6 @@ As a rough guidance, they are best used for:
======== ========================================================= ======= =================
Hardware Resolution needs AI/ML Energy Efficiency
======== ========================================================= ======= =================
CPUs Small (<10M particles) runs and coarse collective effects Yes Low
GPUs Many (>10M) particles and/or detailed collective effects Fastest High
CPUs Small (<10M particles) runs and coarse collective effects Yes Lower
GPUs Many (>10M) particles and/or detailed collective effects Fastest Higher
======== ========================================================= ======= =================
Loading
Loading