From 0282eb859171c71474ab48f99827ed0da1f25994 Mon Sep 17 00:00:00 2001 From: Axel Huebl Date: Mon, 1 Apr 2024 18:10:41 -0700 Subject: [PATCH] Docs: Add Example Subsections (#566) * Docs: Add Example Subsections Add subsections to our example section. * Apply suggestions from code review Co-authored-by: Chad Mitchell <46825199+cemitch99@users.noreply.github.com> --------- Co-authored-by: Chad Mitchell <46825199+cemitch99@users.noreply.github.com> --- docs/source/usage/examples.rst | 52 +++++++++++++++++++++++++++------- 1 file changed, 41 insertions(+), 11 deletions(-) diff --git a/docs/source/usage/examples.rst b/docs/source/usage/examples.rst index 6efcfd11d..678b4d9ec 100644 --- a/docs/source/usage/examples.rst +++ b/docs/source/usage/examples.rst @@ -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 ----------