Skip to content

Commit

Permalink
Docs: Add Example Subsections (#566)
Browse files Browse the repository at this point in the history
* Docs: Add Example Subsections

Add subsections to our example section.

* Apply suggestions from code review

Co-authored-by: Chad Mitchell <[email protected]>

---------

Co-authored-by: Chad Mitchell <[email protected]>
  • Loading branch information
ax3l and cemitch99 authored Apr 2, 2024
1 parent fc6b20a commit 0282eb8
Showing 1 changed file with 41 additions and 11 deletions.
52 changes: 41 additions & 11 deletions docs/source/usage/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,41 +3,71 @@
Examples
========

This section allows you to **download input files** that correspond to different physical situations or test different code features.
This section demonstrates use cases and benchmarks of ImpactX, each correspond to various physical situations and/or test different code features.
Each example provides detailed **input scripts** that can be used as templates for your research projects.


Single Particle Dynamics
------------------------

.. toctree::
:maxdepth: 1

examples/fodo/README.rst
examples/chicane/README.rst
examples/cfchannel/README.rst
examples/expanding_beam/README.rst
examples/kurth/README.rst
examples/alignment/README.rst
examples/rotation/README.rst
examples/rfcavity/README.rst
examples/fodo_rf/README.rst
examples/fodo_chromatic/README.rst
examples/multipole/README.rst
examples/iota_lens/README.rst
examples/iota_lattice/README.rst
examples/solenoid/README.rst
examples/rotation/README.rst
examples/solenoid_softedge/README.rst
examples/quadrupole_softedge/README.rst
examples/positron_channel/README.rst
examples/cyclotron/README.rst
examples/cfbend/README.rst
examples/compression/README.rst
examples/kicker/README.rst
examples/thin_dipole/README.rst
examples/aperture/README.rst
examples/iota_lens/README.rst



Space Charge
------------

.. toctree::
:maxdepth: 1

examples/expanding_beam/README.rst
examples/cfchannel/README.rst
examples/kurth/README.rst
examples/epac2004_benchmarks/README.rst
examples/pytorch_surrogate_model/README.rst
examples/apochromatic/README.rst


Lattice Design & Optimization
-----------------------------

.. toctree::
:maxdepth: 1

examples/fodo_tune/README.rst
examples/optimize_triplet/README.rst


Virtual Test Stands
-------------------

.. toctree::
:maxdepth: 1

examples/cyclotron/README.rst
examples/iota_lattice/README.rst
examples/positron_channel/README.rst
examples/pytorch_surrogate_model/README.rst
examples/apochromatic/README.rst


Unit tests
----------

Expand Down

0 comments on commit 0282eb8

Please sign in to comment.