Skip to content

Commit

Permalink
Doc: Clean Example TODOs
Browse files Browse the repository at this point in the history
Moves TODOs to issues. Thanks everyone who added new user-facing docs!
  • Loading branch information
ax3l committed Jan 5, 2024
1 parent 920b3e8 commit 0bbd356
Showing 1 changed file with 1 addition and 28 deletions.
29 changes: 1 addition & 28 deletions Docs/source/usage/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,6 @@ Plasma-Based Acceleration
examples/pwfa/README.rst
pwfa.rst

Coming soon:

* LWFA: External injection in the boosted frame
* LWFA: Ionization injection in the lab frame using a LASY data file
* PWFA: External injection in the boosted frame
* PWFA: Self-injection in the lab frame
* MR case?


Laser-Plasma Interaction
------------------------
Expand All @@ -43,11 +35,6 @@ Laser-Plasma Interaction
examples/laser_ion/README.rst
examples/plasma_mirror/README.rst

Coming soon:

* MVA (3D & RZ)
* MR for the planar example?


Particle Accelerator & Beam Physics
-----------------------------------
Expand All @@ -58,12 +45,6 @@ Particle Accelerator & Beam Physics
examples/gaussian_beam/README.rst
examples/beam-beam_collision/README.rst

Coming soon:

* Beam-Beam Collision
* Beam Transport or Injector
* Cathode/source


High Energy Astrophysical Plasma Physics
----------------------------------------
Expand All @@ -90,11 +71,6 @@ Nuclear Fusion

TODO

Coming soon:

* Microchannel
* Magnetically Confined Plasma with a Single Coil - Magnetic bottle: simple geometry with an external field


Fundamental Plasma Physics
--------------------------
Expand All @@ -105,9 +81,6 @@ Fundamental Plasma Physics
examples/langmuir/README.rst
examples/capacitive_discharge/README.rst

Coming soon:

* Expanding Sphere example

.. _examples-hybrid-model:

Expand Down Expand Up @@ -150,7 +123,7 @@ Manipulating fields via Python

.. note::

TODO: The section needs to be sorted into either science cases (above) or later sections (workflows and Python API details).
TODO: The section needs to be sorted into either science cases (above) or later sections (:ref:`workflows and Python API details <usage-python-extend>`).

An example of using Python to access the simulation charge density, solve the Poisson equation (using ``superLU``) and write the resulting electrostatic potential back to the simulation is given in the input file below. This example uses the ``fields.py`` module included in the ``pywarpx`` library.

Expand Down

0 comments on commit 0bbd356

Please sign in to comment.