Skip to content

Commit 3839647

Browse files
authored
Docs: inputs section cleanup - intro (BLAST-WarpX#6386)
Rewrite introductory lines. Split from BLAST-WarpX#6355.
1 parent aa5ccf7 commit 3839647

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

Docs/source/usage/parameters.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@
33
Inputs: Parameter List
44
======================
55

6-
This documents on how to use WarpX with an inputs file (e.g., ``warpx.3d input_3d``).
6+
This section describes the list of parameters that can be set in the WarpX inputs file.
77

8-
Complete example input files can be found in :ref:`the examples section <usage-examples>`.
8+
Examples of inputs files can be found in the :ref:`Examples <usage-examples>` section.
99

1010
.. note::
1111

12-
WarpX input options are read via AMReX `ParmParse <https://amrex-codes.github.io/amrex/docs_html/Basics.html#parmparse>`__.
12+
WarpX's input paramters are read via AMReX's `ParmParse <https://amrex-codes.github.io/amrex/docs_html/Basics.html#parmparse>`__.
1313

1414
.. note::
1515

16-
The AMReX parser (see :ref:`running-cpp-parameters-parser`) is used for the right-hand-side of all input parameters that consist of one or more integers or floats, so expressions like ``<species_name>.density_max = "2.+1."`` and/or using user-defined constants are accepted.
16+
The AMReX parser (see :ref:`running-cpp-parameters-parser`) is used for the right-hand side of all input parameters that consist of one or more integers or floats. Expressions like ``<species_name>.density_max = "0.1+2.3"`` and expressions that include user-defined constants are accepted.
1717

1818
.. _running-cpp-parameters-overall:
1919

0 commit comments

Comments
 (0)