diff options
Diffstat (limited to 'Docs')
| -rw-r--r-- | Docs/source/install/dependencies.rst | 8 | ||||
| -rw-r--r-- | Docs/source/install/hpc/summit.rst | 1 | ||||
| -rw-r--r-- | Docs/source/usage/parameters.rst | 25 |
3 files changed, 25 insertions, 9 deletions
diff --git a/Docs/source/install/dependencies.rst b/Docs/source/install/dependencies.rst index d2ff50898..0c28b14ff 100644 --- a/Docs/source/install/dependencies.rst +++ b/Docs/source/install/dependencies.rst @@ -74,7 +74,7 @@ If you also want to run runtime tests and added Python (``spack add python`` and .. code-block:: bash - python3 -m pip install matplotlib yt scipy numpy openpmd-api virtualenv + python3 -m pip install matplotlib yt scipy pandas numpy openpmd-api virtualenv If you want to run the ``./run_test.sh`` :ref:`test script <developers-testing>`, which uses our legacy GNUmake build system, you need to set the following environment hints after ``spack env activate warpx-dev`` for dependent software: @@ -125,7 +125,7 @@ Without MPI: .. code-block:: bash - conda create -n warpx-dev -c conda-forge blaspp ccache cmake compilers git lapackpp openpmd-api python numpy scipy yt fftw matplotlib mamba ninja pip virtualenv + conda create -n warpx-dev -c conda-forge blaspp ccache cmake compilers git lapackpp openpmd-api python numpy pandas scipy yt fftw matplotlib mamba ninja pip virtualenv source activate warpx-dev # compile WarpX with -DWarpX_MPI=OFF @@ -134,7 +134,7 @@ With MPI (only Linux/macOS): .. code-block:: bash - conda create -n warpx-dev -c conda-forge blaspp ccache cmake compilers git lapackpp "openpmd-api=*=mpi_openmpi*" python numpy scipy yt "fftw=*=mpi_openmpi*" matplotlib mamba ninja openmpi pip virtualenv + conda create -n warpx-dev -c conda-forge blaspp ccache cmake compilers git lapackpp "openpmd-api=*=mpi_openmpi*" python numpy pandas scipy yt "fftw=*=mpi_openmpi*" matplotlib mamba ninja openmpi pip virtualenv source activate warpx-dev For legacy ``GNUmake`` builds, after each ``source activate warpx-dev``, you also need to set: @@ -152,7 +152,7 @@ Apt (Debian/Ubuntu) .. code-block:: bash sudo apt update - sudo apt install build-essential ccache cmake g++ git libfftw3-mpi-dev libfftw3-dev libhdf5-openmpi-dev libopenmpi-dev pkg-config python3 python3-matplotlib python3-numpy python3-pip python3-scipy python3-venv + sudo apt install build-essential ccache cmake g++ git libfftw3-mpi-dev libfftw3-dev libhdf5-openmpi-dev libopenmpi-dev pkg-config python3 python3-matplotlib python3-numpy python3-pandas python3-pip python3-scipy python3-venv # optional: # for CUDA, either install diff --git a/Docs/source/install/hpc/summit.rst b/Docs/source/install/hpc/summit.rst index 7b5a67f31..c6cbd081e 100644 --- a/Docs/source/install/hpc/summit.rst +++ b/Docs/source/install/hpc/summit.rst @@ -130,6 +130,7 @@ Optionally, download and install Python packages for :ref:`PICMI <usage-picmi>` python3 -m pip install --upgrade wheel python3 -m pip install --upgrade cython python3 -m pip install --upgrade numpy + python3 -m pip install --upgrade pandas python3 -m pip install --upgrade scipy python3 -m pip install --upgrade mpi4py --no-binary mpi4py python3 -m pip install --upgrade openpmd-api diff --git a/Docs/source/usage/parameters.rst b/Docs/source/usage/parameters.rst index 176a2b6ed..0039007ce 100644 --- a/Docs/source/usage/parameters.rst +++ b/Docs/source/usage/parameters.rst @@ -2132,10 +2132,26 @@ Reduced Diagnostics * ``FieldProbe`` This type computes the value of each component of the electric and magnetic fields - and of the Poynting vector (a measure of electromagnetic flux) at a point in the domain. - The point where the fields are measured is specified through the input parameters - ``<reduced_diags_name>.x_probe``, ``<reduced_diags_name>.y_probe`` and - ``<reduced_diags_name>.z_probe``. + and of the Poynting vector (a measure of electromagnetic flux) at points in the domain. + + Multiple geometries for point probes can be specified via ``<reduced_diags_name>.probe_geometry = ...``: + + * ``Point`` (default): a single point + * ``Line``: a line of points with equal spacing + * ``Plane``: a plane of points with equal spacing + + **Point**: The point where the fields are measured is specified through the input parameters ``<reduced_diags_name>.x_probe``, ``<reduced_diags_name>.y_probe`` and ``<reduced_diags_name>.z_probe``. + + **Line**: probe a 1 dimensional line of points to create a line detector. + Initial input parameters ``x_probe``, ``y_probe``, and ``z_probe`` designate one end of the line detector, while the far end is specified via ``<reduced_diags_name>.x1_probe``, ``<reduced_diags_name>.y1_probe``, ``<reduced_diags_name>.z1_probe``. + Additionally, ``<reduced_diags_name>.resolution`` must be defined to give the number of detector points along the line (equally spaced) to probe. + + **Plane**: probe a 2 dimensional plane of points to create a square plane detector. + Initial input parameters ``x_probe``, ``y_probe``, and ``z_probe`` designate the center of the detector. + The detector plane is normal to a vector specified by ``<reduced_diags_name>.target_normal_x``, ``<reduced_diags_name>.target_normal_y``, and ``<reduced_diags_name>.target_normal_z``. + The top of the plane is perpendicular to an "up" vector denoted by ``<reduced_diags_name>.target_up_x``, ``<reduced_diags_name>.target_up_y``, and ``<reduced_diags_name>.target_up_z``. + The detector has a square radius to be determined by ``<reduced_diags_name>.detector_radius``. + Similarly to the line detector, the plane detector requires a resolution ``<reduced_diags_name>.resolution``, which denotes the number of detector particles along each side of the square detector. The output columns are the value of the :math:`E_x` field, @@ -2157,7 +2173,6 @@ Reduced Diagnostics Integrated electric and magnetic field components can instead be obtained by specifying ``<reduced_diags_name>.integrate == true``. - * ``RhoMaximum`` This type computes the maximum and minimum values of the total charge density as well as the maximum absolute value of the charge density of each charged species. |