diff options
| author |  MaxThevenet <mthevenet@lbl.gov>
| 2020-01-21 14:29:55 -0800 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2020-01-21 14:29:55 -0800 |
| commit | 6abaac6d206162963ce9fab6c833708425f7a2ab (patch) | |
| tree | ad2cdf6c49e65a06fe0ca9710249a103e9c46442 /Docs/source/running_cpp | |
| parent | 568287054236c836db3c76cd163a8a53b6e85c74 (diff) | |
| parent | a6f91fd0020da8e27b2f457ae805678bd7862e3a (diff) | |
| download | WarpX-6abaac6d206162963ce9fab6c833708425f7a2ab.tar.gz WarpX-6abaac6d206162963ce9fab6c833708425f7a2ab.tar.zst WarpX-6abaac6d206162963ce9fab6c833708425f7a2ab.zip | |
Merge pull request #644 from ax3l/topic-authors
Authors Input Option
Diffstat (limited to 'Docs/source/running_cpp')
| -rw-r--r-- | Docs/source/running_cpp/parameters.rst | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/Docs/source/running_cpp/parameters.rst b/Docs/source/running_cpp/parameters.rst index 3498b8203..cba041e6d 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. |