aboutsummaryrefslogtreecommitdiff
path: root/Docs/source/running_cpp
diff options
context:
space:
mode:
Diffstat (limited to 'Docs/source/running_cpp')
-rw-r--r--Docs/source/running_cpp/parameters.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/Docs/source/running_cpp/parameters.rst b/Docs/source/running_cpp/parameters.rst
index 8bc3756e6..5925d4d6b 100644
--- a/Docs/source/running_cpp/parameters.rst
+++ b/Docs/source/running_cpp/parameters.rst
@@ -9,6 +9,10 @@ Input parameters
Overall simulation parameters
-----------------------------
+* ``authors`` (`string`: e.g. ``"Jane Doe <jane@example.com>, Jimmy Joe <jimmy@example.com>"``)
+ Authors of an input file / simulation setup.
+ When provided, this information is added as metadata to (openPMD) output files.
+
* ``max_step`` (`integer`)
The number of PIC cycles to perform.