Skip to content

Commit

Permalink
Added a figure for the coordinate system
Browse files Browse the repository at this point in the history
  • Loading branch information
lfarv committed Dec 13, 2024
1 parent da5fc9a commit 62982b1
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 2 deletions.
3 changes: 2 additions & 1 deletion docs/common/indx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ The AT coordinate system is based on a design trajectory along which the magneti
elements are aligned, and a reference particle:

.. image:: /images/coord_system.*

:alt: coordinate system
:align: center

By convention, the reference particle travels along the design trajectory at constant
nominal energy and defines the phase origin of the RF voltage.
Expand Down
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@
# -- Options for the myst markdown parser ------------------------------------

myst_enable_extensions = [
"attrs_inline",
"colon_fence",
"dollarmath",
"replacements",
Expand Down
Binary file added docs/images/coord_system.pdf
Binary file not shown.
5 changes: 4 additions & 1 deletion docs/p/notebooks/ATPrimer.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,10 @@
"The AT coordinate system is based on a design trajectory along which the magnetic elements are aligned,\n",
"and a reference particle:\n",
"\n",
"![coordinate system](/images/coord_system.png)\n",
"```{image} /images/coord_system.png\n",
":alt: coordinate system\n",
":align: center\n",
"```\n",
"\n",
"By convention, the reference particle travels along the design trajectory at constant nominal energy and defines the phase origin of the RF voltage.\n",
"\n",
Expand Down

0 comments on commit 62982b1

Please sign in to comment.