Skip to content

Commit 9b48df9

Browse files
authored
Doc: Clean Example TODOs (#4584)
Moves TODOs to issues. Thanks everyone who added new user-facing docs!
1 parent 5b765dc commit 9b48df9

File tree

1 file changed

+1
-28
lines changed

1 file changed

+1
-28
lines changed

Docs/source/usage/examples.rst

+1-28
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,6 @@ Plasma-Based Acceleration
2525
examples/pwfa/README.rst
2626
pwfa.rst
2727

28-
Coming soon:
29-
30-
* LWFA: External injection in the boosted frame
31-
* LWFA: Ionization injection in the lab frame using a LASY data file
32-
* PWFA: External injection in the boosted frame
33-
* PWFA: Self-injection in the lab frame
34-
* MR case?
35-
3628

3729
Laser-Plasma Interaction
3830
------------------------
@@ -43,11 +35,6 @@ Laser-Plasma Interaction
4335
examples/laser_ion/README.rst
4436
examples/plasma_mirror/README.rst
4537

46-
Coming soon:
47-
48-
* MVA (3D & RZ)
49-
* MR for the planar example?
50-
5138

5239
Particle Accelerator & Beam Physics
5340
-----------------------------------
@@ -58,12 +45,6 @@ Particle Accelerator & Beam Physics
5845
examples/gaussian_beam/README.rst
5946
examples/beam-beam_collision/README.rst
6047

61-
Coming soon:
62-
63-
* Beam-Beam Collision
64-
* Beam Transport or Injector
65-
* Cathode/source
66-
6748

6849
High Energy Astrophysical Plasma Physics
6950
----------------------------------------
@@ -90,11 +71,6 @@ Nuclear Fusion
9071

9172
TODO
9273

93-
Coming soon:
94-
95-
* Microchannel
96-
* Magnetically Confined Plasma with a Single Coil - Magnetic bottle: simple geometry with an external field
97-
9874

9975
Fundamental Plasma Physics
10076
--------------------------
@@ -105,9 +81,6 @@ Fundamental Plasma Physics
10581
examples/langmuir/README.rst
10682
examples/capacitive_discharge/README.rst
10783

108-
Coming soon:
109-
110-
* Expanding Sphere example
11184

11285
.. _examples-hybrid-model:
11386

@@ -150,7 +123,7 @@ Manipulating fields via Python
150123

151124
.. note::
152125

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

155128
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.
156129

0 commit comments

Comments
 (0)