aboutsummaryrefslogtreecommitdiff
path: root/Docs/source/running_cpp
diff options
context:
space:
mode:
authorGravatar RevathiJambunathan <revanathan@gmail.com> 2020-01-22 10:55:31 -0800
committerGravatar RevathiJambunathan <revanathan@gmail.com> 2020-01-22 10:55:31 -0800
commit37658d9be9d9368f94bd95ec6d2f1cd0e5f3bf3b (patch)
tree10c4d4c2a5efeee1642f88fca4591abc2266855c /Docs/source/running_cpp
parent3c8d481997a0a5063fd32b68d907cf1f70b10e8e (diff)
parent6abaac6d206162963ce9fab6c833708425f7a2ab (diff)
downloadWarpX-37658d9be9d9368f94bd95ec6d2f1cd0e5f3bf3b.tar.gz
WarpX-37658d9be9d9368f94bd95ec6d2f1cd0e5f3bf3b.tar.zst
WarpX-37658d9be9d9368f94bd95ec6d2f1cd0e5f3bf3b.zip
fixing merge conflict with dev
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.