diff options
Diffstat (limited to 'Docs/source/building/python.rst')
| -rw-r--r-- | Docs/source/building/python.rst | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/Docs/source/building/python.rst b/Docs/source/building/python.rst new file mode 100644 index 000000000..e19248d88 --- /dev/null +++ b/Docs/source/building/python.rst @@ -0,0 +1,27 @@ +Installing WarpX as a Python package +------------------------------------ + +Type + +:: + + make -j 4 USE_PYTHON_MAIN=TRUE + +or edit the GNUmakefile and set `USE_PYTHON_MAIN=TRUE`, and type + +:: + + make -j 4 + +This will compile the code, and install the Python bindings as a package (named +``pywarpx``) in your standard Python installation (i.e. in your +``site-packages`` directory). The note on compiler options from the previous +section also holds when compiling the Python package. + +In case you do not have write permissions to the default Python installation (e.g. typical on computer clusters), use the following command instead: + +:: + + make -j 4 PYINSTALLOPTIONS=--user + +In this case, you can also set the variable `PYTHONUSERBASE` to set the folder where `pywarpx` will be installed. |