diff options
Diffstat (limited to 'Docs/source')
| -rw-r--r-- | Docs/source/building/building.rst | 11 | ||||
| -rw-r--r-- | Docs/source/building/openpmd.rst | 2 | ||||
| -rw-r--r-- | Docs/source/conf.py | 4 | ||||
| -rw-r--r-- | Docs/source/developers/developers.rst | 2 | ||||
| -rw-r--r-- | Docs/source/developers/documentation.rst | 2 | ||||
| -rw-r--r-- | Docs/source/running_cpp/parameters.rst | 4 |
6 files changed, 22 insertions, 3 deletions
diff --git a/Docs/source/building/building.rst b/Docs/source/building/building.rst index 140659ec8..461699232 100644 --- a/Docs/source/building/building.rst +++ b/Docs/source/building/building.rst @@ -62,6 +62,17 @@ In order to clean a previously compiled version: make realclean +Troubleshooting +--------------- + +If you are having trouble compiling WarpX, you should try to run: + +:: + + make realclean + +before re-attempting compilation. + Advanced building instructions ------------------------------ diff --git a/Docs/source/building/openpmd.rst b/Docs/source/building/openpmd.rst index 80edf5c85..4c71a11a4 100644 --- a/Docs/source/building/openpmd.rst +++ b/Docs/source/building/openpmd.rst @@ -7,7 +7,7 @@ therefore we recommend to use `spack <https:// spack.io>`__ in order to facilitate the installation. More specifically, we recommend that you try installing the -`openPMD-api library 0.9.0a or newer <https://openpmd-api.readthedocs.io/en/0.9.0-alpha/>`__ +`openPMD-api library 0.10.3a or newer <https://openpmd-api.readthedocs.io/en/0.10.3-alpha/>`__ using spack (first section below). If this fails, a back-up solution is to install parallel HDF5 with spack, and then install the openPMD-api library from source. diff --git a/Docs/source/conf.py b/Docs/source/conf.py index 4a4716b66..f4d487aab 100644 --- a/Docs/source/conf.py +++ b/Docs/source/conf.py @@ -100,7 +100,7 @@ numfig = True # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = [] #['_static'] +html_static_path = ['_static'] # -- Options for HTMLHelp output ------------------------------------------ @@ -194,4 +194,4 @@ highlight_language = 'cpp' read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True' if read_the_docs_build: - subprocess.call('cd ../; doxygen', shell=True) + subprocess.call('cd ../; doxygen; mkdir -p source/_static; cp -r doxyhtml source/_static/', shell=True) diff --git a/Docs/source/developers/developers.rst b/Docs/source/developers/developers.rst index 4eab0102a..777c2f77b 100644 --- a/Docs/source/developers/developers.rst +++ b/Docs/source/developers/developers.rst @@ -5,6 +5,8 @@ Developers documentation For general information on how to contribute to WarpX, including our ``git`` workflow and code practices, have a look at our `CONTRIBUTING.md <https://github.com/ECP-WarpX/WarpX/blob/dev/CONTRIBUTING.md>`__! +Our Doxygen API documentation in classic formatting `is located here <../_static/doxyhtml/index.html>`_. + .. toctree:: :maxdepth: 1 diff --git a/Docs/source/developers/documentation.rst b/Docs/source/developers/documentation.rst index a6f06c7bd..45ff4cd46 100644 --- a/Docs/source/developers/documentation.rst +++ b/Docs/source/developers/documentation.rst @@ -35,6 +35,8 @@ Doxygen reads this docstring, so please be accurate with the syntax! See `Doxyge */ void my_class::my_function(int* my_int); +A HTML rendered version of the Doxygen documentation `is located here <../_static/doxyhtml/index.html>`_. + Breathe documentation --------------------- diff --git a/Docs/source/running_cpp/parameters.rst b/Docs/source/running_cpp/parameters.rst index 597d36996..08804bb9b 100644 --- a/Docs/source/running_cpp/parameters.rst +++ b/Docs/source/running_cpp/parameters.rst @@ -696,6 +696,10 @@ Numerics and algorithms - ``direct``: simpler current deposition algorithm, described in the section :doc:`../theory/picsar_theory`. Note that this algorithm is not strictly charge-conserving. + If ``algo.current_deposition`` is not specified, the default is + ``esirkepov`` (unless WarpX is compiled with ``USE_PSATD=TRUE``, in which + case the default is ``direct``). + * ``algo.charge_deposition`` (`string`, optional) The algorithm for the charge density deposition. Available options are: |