Skip to content

Commit c20b4e7

Browse files
committed
Docs: fix reStructuredText syntax for figures
1 parent 005ef77 commit c20b4e7

File tree

17 files changed

+55
-36
lines changed

17 files changed

+55
-36
lines changed

Docs/source/dataanalysis/picviewer.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ PICViewer
22
=========
33

44
.. figure:: sample_image.png
5-
:alt: picture
5+
:alt: figure not found
66

77
PICViewer is a visualization GUI implemented on PyQt.
88
The toolkit provides various easy-to-use functions for data analysis of

Docs/source/dataanalysis/visit.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Assuming that you ran a 2D simulation, here are instructions for making a simple
2626
Your image should look similar to the one below
2727

2828
.. figure:: Ez.png
29-
:alt: picture
29+
:alt: figure not found
3030

3131

3232
In 3D, you must apply the “Operators” -> “Slicing”

Docs/source/dataanalysis/visualpic.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,11 @@ Example: ``vpic3d -s beam -rho -Ez diags/diag1/`` could be used to visualize the
3232
Example: ``vpic3d -Ex diags/diag1/`` could be used to visualize the transverse focusing field :math:`E_x` in a plasma wake behind a laser pulse (linearly polarized in :math:`E_y`), see below:
3333

3434
.. figure:: https://user-images.githubusercontent.com/1353258/233236692-4d75b12f-de44-43dc-97bd-c96b04ee68ac.png
35-
:alt: Example view of a 3D rendering with VisualPIC.
35+
:alt: figure not found
3636
:width: 100%
3737

38+
Example view of a 3D rendering with VisualPIC.
39+
3840
The **Python script** controlled rendering allows more flexible options, such as selecting and cutting views, rendering directly into an image file, looping for animations, etc.
3941
As with matplotlib scripts, Python script scenes can also be used to open a GUI and then browse time series interactively.
4042
The `VisualPIC examples <https://github.com/AngelFP/VisualPIC/tree/dev/examples>`__ provide showcases for scripting.

Docs/source/dataanalysis/workflows/tunneling.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,5 +52,7 @@ To close the connection down, do this:
5252
* ``Ctrl+C`` the SSH tunnel in terminal B
5353

5454
.. figure:: https://user-images.githubusercontent.com/1353258/232120440-3965fa38-9ca6-4621-a100-2da74eb899cf.png
55-
:alt: Example view of remote started Jupyter service, active SSH tunnel, and local browser connecting to the service.
55+
:alt: figure not found
5656
:width: 100%
57+
58+
Example view of remote started Jupyter service, active SSH tunnel, and local browser connecting to the service.

Docs/source/developers/checksum.rst

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -89,17 +89,23 @@ Alternatively, the benchmarks can be reset using the output of the Azure continu
8989
* On the Github page of the Pull Request, find (one of) the pipeline(s) failing due to benchmarks that need to be updated and click on "Details".
9090

9191
.. figure:: https://user-images.githubusercontent.com/49716072/135133589-1fd8a626-ff93-4b9e-983f-acee028e0e4e.png
92-
:alt: Screen capture showing how to access Azure pipeline output on Github.
92+
:alt: figure not found
93+
94+
Screen capture showing how to access Azure pipeline output on Github.
9395

9496
* Click on "View more details on Azure pipelines".
9597

9698
.. figure:: https://user-images.githubusercontent.com/49716072/135133596-8f73afa2-969e-49a4-b4a6-184a4f478a44.png
97-
:alt: Screen capture showing how to access Azure pipeline output on Github.
99+
:alt: figure not found
100+
101+
Screen capture showing how to access Azure pipeline output on Github.
98102

99103
* Click on "Build & test".
100104

101105
.. figure:: https://user-images.githubusercontent.com/49716072/135133607-87324124-6145-4589-9a92-dcc8ea9432e4.png
102-
:alt: Screen capture showing how to access Azure pipeline output on Github.
106+
:alt: figure not found
107+
108+
Screen capture showing how to access Azure pipeline output on Github.
103109

104110
From this output, there are two options to reset the benchmarks:
105111

@@ -108,7 +114,9 @@ From this output, there are two options to reset the benchmarks:
108114
For instance, if the failing test is ``LaserAcceleration_BTD``, this content can be pasted into the file ``Regression/Checksum/benchmarks_json/LaserAcceleration_BTD.json``.
109115

110116
.. figure:: https://user-images.githubusercontent.com/49716072/244415944-3199a933-990b-4bde-94b1-162b7e8e22be.png
111-
:alt: Screen capture showing how to read new benchmark file from Azure pipeline output.
117+
:alt: figure not found
118+
119+
Screen capture showing how to read new benchmark file from Azure pipeline output.
112120

113121
#. If there are many tests failing in a single Azure pipeline, it might become more convenient to update the benchmarks automatically.
114122
WarpX provides a script for this, located in ``Tools/DevUtils/update_benchmarks_from_azure_output.py``.
@@ -117,12 +125,16 @@ From this output, there are two options to reset the benchmarks:
117125
* From the Azure output, click on "View raw log".
118126

119127
.. figure:: https://user-images.githubusercontent.com/49716072/135133617-764b6daf-a8e4-4a50-afae-d4b3a7568b2f.png
120-
:alt: Screen capture showing how to download raw Azure pipeline output.
128+
:alt: figure not found
129+
130+
Screen capture showing how to download raw Azure pipeline output.
121131

122132
* This should lead to a page that looks like the image below. Save it as a text file on your local computer.
123133

124134
.. figure:: https://user-images.githubusercontent.com/49716072/135133624-310df207-5f87-4260-9917-26d5af665d60.png
125-
:alt: Screen capture showing how to download raw Azure pipeline output.
135+
:alt: figure not found
136+
137+
Screen capture showing how to download raw Azure pipeline output.
126138

127139
* On your local computer, go to the WarpX folder and cd to the ``Tools/DevUtils`` folder.
128140

Docs/source/theory/amr.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Mesh refinement
66
.. _fig_ESAMR:
77

88
.. figure:: ICNSP_2011_Vay_fig1.png
9-
:alt: Sketches of the implementation of mesh refinement in WarpX with the electrostatic (left) and electromagnetic (right) solvers. In both cases, the charge/current from particles are deposited at the finest levels first, then interpolated recursively to coarser levels. In the electrostatic case, the potential is calculated first at the coarsest level :math:`L_0`, the solution interpolated to the boundaries of the refined patch :math:`r` at the next level :math:`L_{1}` and the potential calculated at :math:`L_1`. The procedure is repeated iteratively up to the highest level. In the electromagnetic case, the fields are computed independently on each grid and patch without interpolation at boundaries. Patches are terminated by absorbing layers (PML) to prevent the reflection of electromagnetic waves. Additional coarse patch :math:`c` and fine grid :math:`a` are needed so that the full solution is obtained by substitution on :math:`a` as :math:`F_{n+1}(a)=F_{n+1}(r)+I[F_n( s )-F_{n+1}( c )]` where :math:`F` is the field, and :math:`I` is a coarse-to-fine interpolation operator. In both cases, the field solution at a given level :math:`L_n` is unaffected by the solution at higher levels :math:`L_{n+1}` and up, allowing for mitigation of some spurious effects (see text) by providing a transition zone via extension of the patches by a few cells beyond the desired refined area (red & orange rectangles) in which the field is interpolated onto particles from the coarser parent level only.
9+
:alt: figure not found
1010
:width: 95%
1111

1212
Sketches of the implementation of mesh refinement in WarpX with the electrostatic (left) and electromagnetic (right) solvers. In both cases, the charge/current from particles are deposited at the finest levels first, then interpolated recursively to coarser levels. In the electrostatic case, the potential is calculated first at the coarsest level :math:`L_0`, the solution interpolated to the boundaries of the refined patch :math:`r` at the next level :math:`L_{1}` and the potential calculated at :math:`L_1`. The procedure is repeated iteratively up to the highest level. In the electromagnetic case, the fields are computed independently on each grid and patch without interpolation at boundaries. Patches are terminated by absorbing layers (PML) to prevent the reflection of electromagnetic waves. Additional coarse patch :math:`c` and fine grid :math:`a` are needed so that the full solution is obtained by substitution on :math:`a` as :math:`F_{n+1}(a)=F_{n+1}(r)+I[F_n( s )-F_{n+1}( c )]` where :math:`F` is the field, and :math:`I` is a coarse-to-fine interpolation operator. In both cases, the field solution at a given level :math:`L_n` is unaffected by the solution at higher levels :math:`L_{n+1}` and up, allowing for mitigation of some spurious effects (see text) by providing a transition zone via extension of the patches by a few cells beyond the desired refined area (red & orange rectangles) in which the field is interpolated onto particles from the coarser parent level only.
@@ -25,7 +25,7 @@ A sketch of the implementation of mesh refinement in WarpX is given in :numref:`
2525
.. _fig_ESselfforce:
2626

2727
.. figure:: ICNSP_2011_Vay_fig2.png
28-
:alt: Position history of one charged particle attracted by its image induced by a nearby metallic (dirichlet) boundary. The particle is initialized at rest. Without refinement patch (reference case), the particle is accelerated by its image, is reflected specularly at the wall, then decelerates until it reaches its initial position at rest. If the particle is initialized inside a refinement patch, the particle is initially accelerated toward the wall but is spuriously reflected before it reaches the boundary of the patch whether using the method implemented in WarpX or the MC method. Providing a surrounding transition region 2 or 4 cells wide in which the potential is interpolated from the parent coarse solution reduces significantly the effect of the spurious self-force.
28+
:alt: figure not found
2929
:width: 95%
3030

3131
Position history of one charged particle attracted by its image induced by a nearby metallic (dirichlet) boundary. The particle is initialized at rest. Without refinement patch (reference case), the particle is accelerated by its image, is reflected specularly at the wall, then decelerates until it reaches its initial position at rest. If the particle is initialized inside a refinement patch, the particle is initially accelerated toward the wall but is spuriously reflected before it reaches the boundary of the patch whether using the method implemented in WarpX or the MC method. Providing a surrounding transition region 2 or 4 cells wide in which the potential is interpolated from the parent coarse solution reduces significantly the effect of the spurious self-force.
@@ -35,7 +35,7 @@ The presence of the self-force is illustrated on a simple test case that was int
3535
.. _fig_ESselfforcemap:
3636

3737
.. figure:: ICNSP_2011_Vay_fig3.png
38-
:alt: (left) Maps of the magnitude of the spurious self-force :math:`\epsilon` in arbitrary units within one quarter of the refined patch, defined as :math:`\epsilon=\sqrt{(E_x-E_x^{ref})^2+(E_y-E_y^{ref})^2}`, where :math:`E_x` and :math:`E_y` are the electric field components within the patch experienced by one particle at a given location and :math:`E_x^{ref}` and :math:`E_y^{ref}` are the electric field from a reference solution. The map is given for the WarpX and the MC mesh refinement algorithms and for linear and quadratic interpolation at the patch refinement boundary. (right) Lineouts of the maximum (taken over neighboring cells) of the spurious self-force. Close to the interface boundary (x=0), the spurious self-force decreases at a rate close to one order of magnitude per cell (red line), then at about one order of magnitude per six cells (green line).
38+
:alt: figure not found
3939
:width: 95%
4040

4141
(left) Maps of the magnitude of the spurious self-force :math:`\epsilon` in arbitrary units within one quarter of the refined patch, defined as :math:`\epsilon=\sqrt{(E_x-E_x^{ref})^2+(E_y-E_y^{ref})^2}`, where :math:`E_x` and :math:`E_y` are the electric field components within the patch experienced by one particle at a given location and :math:`E_x^{ref}` and :math:`E_y^{ref}` are the electric field from a reference solution. The map is given for the WarpX and the MC mesh refinement algorithms and for linear and quadratic interpolation at the patch refinement boundary. (right) Lineouts of the maximum (taken over neighboring cells) of the spurious self-force. Close to the interface boundary (x=0), the spurious self-force decreases at a rate close to one order of magnitude per cell (red line), then at about one order of magnitude per six cells (green line).

Docs/source/theory/boosted_frame.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The simulations of plasma accelerators from first principles are extremely compu
88
.. _fig_Boosted_frame:
99

1010
.. figure:: Boosted_frame.png
11-
:alt: [fig:Boosted-frame] A first principle simulation of a short driver beam (laser or charged particles) propagating through a plasma that is orders of magnitude longer necessitates a very large number of time steps. Recasting the simulation in a frame of reference that is moving close to the speed of light in the direction of the driver beam leads to simulating a driver beam that appears longer propagating through a plasma that appears shorter than in the laboratory. Thus, this relativistic transformation of space and time reduces the disparity of scales, and thereby the number of time steps to complete the simulation, by orders of magnitude.
11+
:alt: figure not found
1212

1313
A first principle simulation of a short driver beam (laser or charged particles) propagating through a plasma that is orders of magnitude longer necessitates a very large number of time steps. Recasting the simulation in a frame of reference that is moving close to the speed of light in the direction of the driver beam leads to simulating a driver beam that appears longer propagating through a plasma that appears shorter than in the laboratory. Thus, this relativistic transformation of space and time reduces the disparity of scales, and thereby the number of time steps to complete the simulation, by orders of magnitude.
1414

Docs/source/theory/boosted_frame/input_output.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Inputs and outputs in a boosted frame simulation
1515
.. _fig_inputoutput:
1616

1717
.. figure:: Input_output.png
18-
:alt: (top) Snapshot of a particle beam showing “frozen" (grey spheres) and “active" (colored spheres) macroparticles traversing the injection plane (red rectangle). (bottom) Snapshot of the beam macroparticles (colored spheres) passing through the background of electrons (dark brown streamlines) and the diagnostic stations (red rectangles). The electrons, the injection plane and the diagnostic stations are fixed in the laboratory plane, and are thus counter-propagating to the beam in a boosted frame.
18+
:alt: figure not found
1919
:width: 100%
2020

2121
(top) Snapshot of a particle beam showing “frozen" (grey spheres) and “active" (colored spheres) macroparticles traversing the injection plane (red rectangle). (bottom) Snapshot of the beam macroparticles (colored spheres) passing through the background of electrons (dark brown streamlines) and the diagnostic stations (red rectangles). The electrons, the injection plane and the diagnostic stations are fixed in the laboratory plane, and are thus counter-propagating to the beam in a boosted frame.

Docs/source/theory/boundary_conditions.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -294,7 +294,7 @@ the right boundary is reflecting.
294294
.. _fig_PEC_boundary_deposition:
295295

296296
.. figure:: https://user-images.githubusercontent.com/40245517/221491318-b0a2bcbc-b04f-4b8c-8ec5-e9c92e55ee53.png
297-
:alt: Plot of PEC boundary current deposition showing current vs position along the ``x``-axis.
297+
:alt: figure not found
298298
:width: 100%
299299

300300
PEC boundary current deposition along the ``x``-axis. The left boundary is absorbing while the right boundary is reflecting.

Docs/source/theory/cold_fluid_model.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,9 @@ Implementation details
4545
.. _fig_fluid_loop:
4646

4747
.. figure:: https://github.com/ECP-WarpX/WarpX/assets/69021085/dcbcc0e4-7899-43e4-b580-f57eb359b457
48-
:alt: Figure showing fluid Loop embedded within the overall PIC loop.
48+
:alt: figure not found
4949

50-
Fluid Loop embedded within the overall PIC loop.
50+
Fluid loop embedded within the overall PIC loop.
5151

5252
The fluid timeloop is embedded inside the standard PIC timeloop and consists of
5353
the following steps: 1. Higuera and Cary push of the momentum 2. Non-inertial (momentum source)

0 commit comments

Comments
 (0)