Skip to content

Commit

Permalink
Doc: Streamline Python Input (ECP-WarpX#4472)
Browse files Browse the repository at this point in the history
Start to streamline the PICMI Python input.
  • Loading branch information
ax3l authored Dec 5, 2023
1 parent ef4f922 commit 431bd94
Show file tree
Hide file tree
Showing 9 changed files with 153 additions and 237 deletions.
5 changes: 2 additions & 3 deletions Docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,8 @@ Usage
:hidden:

usage/how_to_run
usage/domain_decomposition
usage/parameters
usage/python
usage/parameters
usage/examples
usage/workflows
usage/faq
Expand Down Expand Up @@ -125,10 +124,10 @@ Development
:hidden:

developers/contributing
developers/workflows
developers/developers
developers/doxygen
developers/gnumake
developers/workflows
developers/faq
.. good to have in the future:
.. developers/repostructure
Expand Down
19 changes: 12 additions & 7 deletions Docs/source/usage/parameters.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
.. _running-cpp-parameters:

Input Parameters
================
Parameters: Inputs File
=======================

This documents on how to use WarpX with an inputs file (e.g., ``warpx.3d input_3d``).

Complete example input files can be found in :ref:`the examples section <usage-examples>`.

.. note::

Expand Down Expand Up @@ -1084,11 +1088,12 @@ Particle initialization
the above mentioned function.

.. note::
When accessing the data via Python, the scraped particle buffer relies on the user
to clear the buffer after processing the data. The
buffer will grow unbounded as particles are scraped and therefore could
lead to memory issues if not periodically cleared. To clear the buffer
call ``warpx_clearParticleBoundaryBuffer()``.

When accessing the data via Python, the scraped particle buffer relies on the user
to clear the buffer after processing the data. The
buffer will grow unbounded as particles are scraped and therefore could
lead to memory issues if not periodically cleared. To clear the buffer
call ``clear_buffer()``.

* ``<species>.do_field_ionization`` (`0` or `1`) optional (default `0`)
Do field ionization for this species (using the ADK theory).
Expand Down
2 changes: 2 additions & 0 deletions Docs/source/usage/pwfa.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _examples-pwfa-boost:

In-Depth: PWFA
==============

Expand Down
Loading

0 comments on commit 431bd94

Please sign in to comment.