Skip to content

Commit 65d9d22

Browse files
committed
Merge branch 'development' into plasma_chamber_ultimate
2 parents 82ca0b3 + 4c77a61 commit 65d9d22

File tree

89 files changed

+4661
-3417
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

89 files changed

+4661
-3417
lines changed

Docs/Makefile

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,3 @@ Python-build:
2828

2929
Doxygen-build:
3030
doxygen Doxyfile
31-
32-
Latex-conversion:
33-
cd source/latex_theory; make

Docs/README.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,3 @@ In order to remove all of the generated files, use:
2727
```
2828
make clean
2929
```
30-
31-
### Regenerating the theory documentation
32-
33-
The theory is generated from Latex sources in PICSAR, and the resulting `.rst`
34-
files are stored in the current repo, in `source/latex_theory`. In order to
35-
regenerate the theory documentation:
36-
```
37-
make Latex-conversion
38-
```

Docs/requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ docutils>=0.17.1
1111

1212
# PICMI API docs
1313
# note: keep in sync with version in ../requirements.txt
14-
picmistandard==0.33.0
14+
picmistandard==0.34.0
1515
# for development against an unreleased PICMI version, use:
1616
# picmistandard @ git+https://github.com/picmi-standard/picmi.git#subdirectory=PICMI_Python
1717

Docs/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ def download_with_headers(url, filename):
8181
templates_path = ["_templates"]
8282

8383
# Relative path to bibliography file, bibliography style
84-
bibtex_bibfiles = ["latex_theory/allbibs.bib", "refs.bib"]
84+
bibtex_bibfiles = ["refs.bib"]
8585

8686

8787
# An brief introduction to custom BibTex formatting can be found in the Sphinx documentation:

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: 0 additions & 78 deletions
This file was deleted.

Docs/source/index.rst

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,11 @@ In addition, WarpX is a *highly-parallel and highly-optimized code*:
2727
Contact us
2828
^^^^^^^^^^
2929

30-
If you are starting using WarpX, or if you have a user question, please pop in our `discussions page <https://github.com/BLAST-WarpX/warpx/discussions>`__ and get in touch with the community.
30+
The `WarpX GitHub repository <https://github.com/BLAST-WarpX/warpx>`__ is the main communication platform:
3131

32-
The `WarpX GitHub repo <https://github.com/BLAST-WarpX/warpx>`__ is the main communication platform.
33-
Have a look at the action icons on the top right of the web page: feel free to watch the repo if you want to receive updates, or to star the repo to support the project.
34-
For bug reports or to request new features, you can also open a new `issue <https://github.com/BLAST-WarpX/warpx/issues>`__.
35-
36-
We also have a `discussion page <https://github.com/BLAST-WarpX/warpx/discussions>`__ on which you can find already answered questions, add new questions, get help with installation procedures, discuss ideas or share comments.
32+
- If you are new to WarpX or have a question, we encourage you to visit our `discussions page <https://github.com/BLAST-WarpX/warpx/discussions>`__ and connect with the community. This page is also a great place to browse answers to previously asked questions, post new ones, get help with installation, exchange ideas, and share feedback.
33+
- You can also explore the icons in the upper right corner of the `WarpX GitHub repository <https://github.com/BLAST-WarpX/warpx>`__ (e.g., ``Watch``, ``Star``, etc.): feel free to watch the repository if you want to receive updates, or to star the repository to support the project.
34+
- For bug reports, feature requests, or installation issues, you can also open a new `issue <https://github.com/BLAST-WarpX/warpx/issues>`__.
3735

3836
.. raw:: html
3937

@@ -120,15 +118,9 @@ Theory
120118
:caption: THEORY
121119
:maxdepth: 1
122120
:hidden:
121+
:titlesonly:
123122

124123
theory/intro
125-
theory/pic
126-
theory/amr
127-
theory/boundary_conditions
128-
theory/boosted_frame
129-
theory/multiphysics_extensions
130-
theory/kinetic_fluid_hybrid_model
131-
theory/cold_fluid_model
132124

133125
Development
134126
-----------

0 commit comments

Comments
 (0)