From 8e45aecf33e5a2ecbef5935444f4a4bbcbc044ba Mon Sep 17 00:00:00 2001 From: AlexanderSinn Date: Wed, 18 Oct 2023 16:39:01 +0200 Subject: [PATCH] fix some of the typos --- docs/source/run/parameters.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/run/parameters.rst b/docs/source/run/parameters.rst index f64fb35066..445f4f376a 100644 --- a/docs/source/run/parameters.rst +++ b/docs/source/run/parameters.rst @@ -436,7 +436,7 @@ which are valid only for certain beam types, are introduced further below under ``fixed_weight_pdf`` generates a beam with a fixed number of particles with a constant weight where the transverse profile is Gaussian and the longitudinal profile is arbitrary according to a user-specified probability density function. Although it is more general it is faster and uses - less memory than ``fixed_weight``. + less memory than ``fixed_weight``, ``from_file`` reads a beam from openPMD files. * ``.element`` (`string`) optional (default `electron`) @@ -490,9 +490,9 @@ Option: ``fixed_weight_pdf`` * ``.pdf`` (`float`) Probability density function to define the longitudinal profile of the beam. - The transverse profile will be Gaussian. This is a parser function of z + The transverse profile is Gaussian. This is a parser function of z that should return the total amount of charge present on each transverse beam slice. - This will also be propartinal to the per-slice peak density if ``.position_mean`` is constant along z, + This will also be proportional to the per-slice peak density if ``.position_mean`` is constant along z, if not the pdf can be calculated from the desired peak density using ``.pdf = * * ``. The probability density function is automatically normalized so that all constant pre factors can be omitted when specifying the function.