Docs Updates

ECP-WarpX · Jan 6, 2025 · a0e147f · a0e147f
1 parent 26f45db
commit a0e147f
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 14 deletions.
diff --git a/docs/source/usage/examples.rst b/docs/source/usage/examples.rst
@@ -31,6 +31,7 @@ Single Particle Dynamics
    examples/aperture/README.rst
    examples/iota_lens/README.rst
    examples/achromatic_spectrometer/README.rst
+   examples/fodo_userdef/README.rst
    examples/fodo_programmable/README.rst
    examples/dogleg/README.rst
    examples/coupled_optics/README.rst

diff --git a/docs/source/usage/workflows/add_element.rst b/docs/source/usage/workflows/add_element.rst
@@ -10,6 +10,25 @@ The workflows described here apply both for thin kicks or thick elements.
 Thick elements can also use soft-edged fringe fields (see `existing soft-edged elements for implementation details <https://github.com/ECP-WarpX/impactx/tree/development/src/particles/elements>`__).
 
 
+.. _usage-workflows-add-element-linmap:
+
+Linear Map
+----------
+
+A custom linear element can be provided by specifying the 6x6 linear transport matrix :math:`R` as an input.
+See the :ref:` example <examples-fodo-userdef>` for Python and inputs file syntax to specify a custom linear element.
+
+The entries of the transport matrix are ordered for multiplication with the beam vector :math:`x,px,y,py,t,pt`.
+The units of the transport matrix :math:`R` elements are... TODO
+
+.. note::
+
+   Note that generally, if a user-provided linear map is used, the beam transport may not be symplectic.
+   Thus, where symplecticity is needed, the :ref:`Python Programmable Element <usage-workflows-add-element-python>` and the :ref:`C++ Element <usage-workflows-add-element-cxx>` provide a more general approach.
+
+
+.. _usage-workflows-add-element-python:
+
 Python Programmable Element
 ---------------------------
 
@@ -30,20 +49,7 @@ Detailed examples that show usage of the programmable element are:
 Detailed particle computing interfaces are presented in the `pyAMReX examples <https://pyamrex.readthedocs.io/en/latest/usage/compute.html#particles>`__.
 
 
-Linear Map
-----------
-
-A custom linear element can be provided by specifying the 6x6 linear transport matrix :math:`R` as an input.
-See the :ref:` example <examples-fodo-userdef>` for Python and inputs file syntax to specify a custom linear element.
-
-The entries of the transport matrix are ordered for multiplication with the beam vector :math:`x,px,y,py,t,pt`.
-The units of the transport matrix :math:`R` elements are... TODO
-
-.. note::
-
-   Note that generally, if a user-provided linear map is used, the beam transport may not be symplectic.
-   Thus, where symplecticity is needed, the programmable element and the C++ element provide a more general approach.
-
+.. _usage-workflows-add-element-cxx:
 
 C++ Element
 -----------