diff options
author | 2017-10-22 07:46:33 -0700 | |
---|---|---|
committer | 2017-10-22 07:46:33 -0700 | |
commit | 94385cef8da5c96e4c5bb62ed0e15cceb2d4ac62 (patch) | |
tree | c06c7044b1d00192b651f62575408a4d615ae91c /Docs/source/running_python/how_to_run.rst | |
parent | 13ab3acd7ca91678cd849e2e900f315bf3df72bd (diff) | |
download | WarpX-94385cef8da5c96e4c5bb62ed0e15cceb2d4ac62.tar.gz WarpX-94385cef8da5c96e4c5bb62ed0e15cceb2d4ac62.tar.zst WarpX-94385cef8da5c96e4c5bb62ed0e15cceb2d4ac62.zip |
Added more documentation for Python wrapper
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. |