diff options
Diffstat (limited to 'Docs/source/running_python/how_to_run.rst')
| -rw-r--r-- | Docs/source/running_python/how_to_run.rst | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/Docs/source/running_python/how_to_run.rst b/Docs/source/running_python/how_to_run.rst new file mode 100644 index 000000000..54568a64c --- /dev/null +++ b/Docs/source/running_python/how_to_run.rst @@ -0,0 +1,25 @@ +How to run a new simulation +=========================== + +After installing WarpX as a Python package (see the section +:doc:`../installation`), you can use its functionalities in a Python script +to run a simulation. + +In order to run a new simulation: + +* Create a **new directory**, where the simulation will be run. + +* Add a **Python script** in the directory. + +This file contains the numerical and physical parameters that define +the situation to be simulated. +Example input files can be found in the section :doc:`examples`. + +* **Run** the script with Python: + +:: + + mpirun -np <n_ranks> python <python_script> + +where ``<n_ranks>`` is the number of MPI ranks used, and ``<python_script>`` +is the name of the script. |