Skip to content

Commit 30e6dfe

Browse files
committed
Docs: Minor Formatting
Fix minor rst formatting errors in the manual.
1 parent 1a1ad65 commit 30e6dfe

File tree

3 files changed

+10
-6
lines changed

3 files changed

+10
-6
lines changed

docs/source/usage/plugins/positionsParticles.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ negligible.
2929
Output
3030
^^^^^^
3131

32-
The electron trajectory is written directly to the *standard out*.
33-
Therefore, it goes both to ``./simOutput/output`` as well as to the output file specified by the machine used (usually the ``stdout`` file in the main directory of the simulation).
32+
The electron trajectory is written directly to the *standard output*.
33+
Therefore, it goes both to ``simOutput/output`` as well as to the output file specified by the machine used (usually the ``stdout`` file in the main directory of the simulation).
3434
The output is ASCII-text only.
3535
It has the following format:
3636

@@ -59,7 +59,7 @@ Value Description
5959
[ANALYSIS] [2] [COUNTER] [e_position] [878] 1.46440742e-14 {1.032e-05 4.570851689815522e-05 5.2e-06} {0 -1.
6060
337873603181226e-21 0} 9.109382e-31 1 -1.602176e-19 4.999998569488525
6161
62-
In order to extract only the trajectory information from the total output stored in `stdout`, the following command on a bash command line could be used:
62+
In order to extract only the trajectory information from the total output stored in ``stdout``, the following command on a bash command line could be used:
6363

6464
.. code:: bash
6565
@@ -84,5 +84,5 @@ Known Issues
8484

8585
.. attention::
8686

87-
Currently, both `output` and `stdout`are overwritten at restart.
87+
Currently, both ``simOutput/output`` and ``stdout`` are overwritten at restart.
8888
All data from the plugin is lost, if these file are not backuped manually.

share/picongpu/examples/Empty/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ Empty: Default PIC Algorithm
44
.. sectionauthor:: Axel Huebl <a.huebl (at) hzdr.de>
55

66
This is an "empty" example, initializing a default particle-in-cell cycle with default algorithms [BirdsallLangdon]_ [HockneyEastwood]_ but without a specific test case.
7-
When run, it iterates a particle-in-cell algorithm on a vacuum without particles or electro-magnetic fields initialized, which are the default `.param` files in `include/picongpu/param/`.
7+
When run, it iterates a particle-in-cell algorithm on a vacuum without particles or electro-magnetic fields initialized, which are the default ``.param`` files in ``include/picongpu/param/``.
88

99
This is a case to demonstrate and test these defaults are still (syntactically) working.
10-
In order to set up your own simulation, there is no need to overwrite all `.param` files but only the ones that are different from the defaults.
10+
In order to set up your own simulation, there is no need to overwrite all ``.param`` files but only the ones that are different from the defaults.
1111
As an example, just overwrite the default laser (none) and initialize a species with a density distribution.
1212

1313

share/picongpu/examples/WarmCopper/README.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ The observable of interest is <Z> over time of the copper ions.
1111
For low thermal energies, collisional excitation, de-excitation and recombinations should be sufficient to reach the LTE state after about 0.1-1 ps.
1212
For higher initial temperatures, radiative rates get more relevant and the Non-LTE steady-state solution can only be reached correctly when also adding radiative rates.
1313

14+
.. note::
15+
16+
FLYlite is still in development!
17+
1418
.. [#FLYlite] In PIConGPU, we generally refer to the implemented subset of *SCFLY* (solving Non-LTE population kinetics) as *FLYlite*.
1519
1620
References

0 commit comments

Comments
 (0)