Skip to content

Commit

Permalink
Fix broken docs
Browse files Browse the repository at this point in the history
  • Loading branch information
EZoni committed Sep 10, 2024
1 parent 10d1615 commit 9337a16
Show file tree
Hide file tree
Showing 7 changed files with 19 additions and 19 deletions.
2 changes: 1 addition & 1 deletion Docs/source/developers/particles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ Attribute name ``int``/``real`` Description Default
when they were created.
================== ================ ================================= ==============

A Python example that adds runtime options can be found in :download:`Examples/Tests/particle_data_python <../../../Examples/Tests/particle_data_python/PICMI_inputs_prev_pos_2d.py>`
A Python example that adds runtime options can be found in :download:`Examples/Tests/particle_data_python <../../../Examples/Tests/particle_data_python/inputs_test_2d_prev_positions_picmi.py>`

.. note::

Expand Down
30 changes: 15 additions & 15 deletions Docs/source/usage/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ Plasma-Based Acceleration
.. toctree::
:maxdepth: 1

examples/lwfa/README.rst
examples/pwfa/README.rst
examples/lwfa/README
examples/pwfa/README
pwfa.rst


Expand All @@ -32,8 +32,8 @@ Laser-Plasma Interaction
.. toctree::
:maxdepth: 1

examples/laser_ion/README.rst
examples/plasma_mirror/README.rst
examples/laser_ion/README
examples/plasma_mirror/README


Particle Accelerator & Beam Physics
Expand All @@ -42,8 +42,8 @@ Particle Accelerator & Beam Physics
.. toctree::
:maxdepth: 1

examples/gaussian_beam/README.rst
examples/beam-beam_collision/README.rst
examples/gaussian_beam/README
examples/beam_beam_collision/README


High Energy Astrophysical Plasma Physics
Expand All @@ -52,7 +52,7 @@ High Energy Astrophysical Plasma Physics
.. toctree::
:maxdepth: 1

examples/ohm_solver_magnetic_reconnection/README.rst
examples/ohm_solver_magnetic_reconnection/README


Microelectronics
Expand All @@ -78,8 +78,8 @@ Fundamental Plasma Physics
.. toctree::
:maxdepth: 1

examples/langmuir/README.rst
examples/capacitive_discharge/README.rst
examples/langmuir/README
examples/capacitive_discharge/README


.. _examples-hybrid-model:
Expand All @@ -101,9 +101,9 @@ examples below were generated at that time.
.. toctree::
:maxdepth: 1

examples/ohm_solver_EM_modes/README.rst
examples/ohm_solver_ion_beam_instability/README.rst
examples/ohm_solver_ion_Landau_damping/README.rst
examples/ohm_solver_em_modes/README
examples/ohm_solver_ion_beam_instability/README
examples/ohm_solver_ion_Landau_damping/README


High-Performance Computing and Numerics
Expand All @@ -115,7 +115,7 @@ While all prior examples are used for such studies as well, the examples here ne
.. toctree::
:maxdepth: 1

examples/uniform_plasma/README.rst
examples/uniform_plasma/README


Manipulating fields via Python
Expand All @@ -127,11 +127,11 @@ Manipulating fields via Python

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.

* :download:`Direct Poisson solver example <../../../Examples/Physics_applications/capacitive_discharge/PICMI_inputs_2d.py>`
* :download:`Direct Poisson solver example <../../../Examples/Physics_applications/capacitive_discharge/inputs_test_2d_background_mcc_picmi.py>`

An example of initializing the fields by accessing their data through Python, advancing the simulation for a chosen number of time steps, and plotting the fields again through Python. The simulation runs with 128 regular cells, 8 guard cells, and 10 PML cells, in each direction. Moreover, it uses div(E) and div(B) cleaning both in the regular grid and in the PML and initializes all available electromagnetic fields (E,B,F,G) identically.

* :download:`Unit pulse with PML <../../../Examples/Tests/python_wrappers/PICMI_inputs_2d.py>`
* :download:`Unit pulse with PML <../../../Examples/Tests/python_wrappers/inputs_test_2d_python_wrappers_picmi.py>`


Many Further Examples, Demos and Tests
Expand Down
1 change: 0 additions & 1 deletion Docs/source/usage/examples/beam-beam_collision

This file was deleted.

1 change: 1 addition & 0 deletions Docs/source/usage/examples/beam_beam_collision
1 change: 0 additions & 1 deletion Docs/source/usage/examples/ohm_solver_EM_modes

This file was deleted.

1 change: 1 addition & 0 deletions Docs/source/usage/examples/ohm_solver_em_modes
2 changes: 1 addition & 1 deletion Docs/source/usage/pwfa.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ In-Depth: PWFA

As described in the :doc:`../theory/intro`, one of the key applications of the WarpX exascale computing platform is in modelling future, compact and economic plasma-based accelerators.
In this section we describe the simulation setup of a realistic *electron beam driven plasma wakefield accelerator* (PWFA) configuration.
For illustration purposes the setup can be explored with **WarpX** using the example input file :download:`PWFA <../../../Examples/Physics_applications/plasma_acceleration/inputs_2d_boost>`.
For illustration purposes the setup can be explored with **WarpX** using the example input file :download:`PWFA <../../../Examples/Physics_applications/plasma_acceleration/inputs_test_2d_plasma_acceleration_boosted>`.

The simulation setup consists of 4 particle species: drive beam (driver), witness beam (beam), plasma electrons (plasma_e), and plasma ions (plasma_p).
The species physical parameters are summarized in the following table.
Expand Down

0 comments on commit 9337a16

Please sign in to comment.