Major update of the Python/picmi documentation (#3329)

* Include WarpX specific documentation

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Undo the precommit change of import in __init__.py

* Docs: Install Pure Python WarpX PICMI

Allows to use these classes in our Sphinx autodocs in the manual.

* Sphinx: Add Napoleon Extension

https://sphinxcontrib-napoleon.readthedocs.io

* PICMI Doc Strings: Fix Some Warnings

* Removed the DocumentedMetaClass since it was moved to picmistandard

* Defined the languate in Docs/source/conf.py

* Cleaned up minor issues in the rst files

* Updated existing doc strings in picmi.py

* Reformatted doc strings in Regression/Checksum/checksumAPI.py

* Reformatted doc strings in Regression/Checksum

* First set of WarpX specific documentation

* Updated to picmistandard version 0.0.20

* Cleaned up the Python document page

Fixed up the text to be more clear.
Added section headers for each picmi class (for easy reference).

* Further updates to picmi.py doc strings

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>

1 files changed, 3 insertions, 0 deletions

diff --git a/Python/pywarpx/__init__.py b/Python/pywarpx/__init__.py
index 5590c7d6f..8f4960456 100644
--- a/Python/pywarpx/__init__.py
+++ b/Python/pywarpx/__init__.py
@@ -19,3 +19,6 @@ from .PSATD import psatd
 from .Particles import electrons, newspecies, particles, positrons, protons
 from .WarpX import warpx
 from ._libwarpx import libwarpx
+
+# This is a circulor import and must happen after the import of libwarpx
+from . import picmi # isort:skip