Skip to content

Commit

Permalink
Docs: Python
Browse files Browse the repository at this point in the history
  • Loading branch information
ax3l committed Aug 11, 2023
1 parent 789a9cf commit 86b73ba
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
17 changes: 17 additions & 0 deletions Docs/source/Python_Tutorial.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
.. _tutorials_python:

======
Python
======

These examples show how to use AMReX from Python.
AMReX applications can also be interfaced to Python with the same logic.

In order to build the Python tutorials, add ``-DTUTORIAL_PYTHON=ON`` to the CMake configuration options.
Then install with ``cmake --build build --target pip_install``.

Examples:

- ``GuidedTutorials/MultiFab/main.py``

Please see `pyAMReX <https://github.com/AMReX-Codes/pyamrex/>`__ for more details.
4 changes: 4 additions & 0 deletions Docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ sorted by the following categories:
- :ref:`Linear Solvers<tutorials_linearsolvers>` -- Examples of several linear solvers.
- :ref:`MUI<tutorials_mui>` -- Incorporates the MxUI/MUI (Multiscale Universal interface) frame into AMReX.
- :ref:`Particles<tutorials_particles>` -- Basic usage of AMReX's particle data structures.
- :ref:`Python<tutorials_python>` -- Using AMReX and interfacing with AMReX applications form Python - via `pyAMReX <https://github.com/AMReX-Codes/pyamrex/>`__
- :ref:`SDC<tutorials_sdc>` -- Example usage of a "Multi-Implicit" Spectral Deferred Corrections (MISDC) integrator
to solve a scalar advection-diffusion-reaction equation.
- :ref:`SENSEI<tutorials_sensei>` -- In situ data analysis and visualization through a unified interface.
Expand All @@ -71,6 +72,7 @@ sorted by the following categories:
ML_Tutorial
MUI_Tutorial
Particles_Tutorial
Python_Tutorial
SDC_Tutorial
SENSEI_Tutorial
SUNDIALS_Tutorial
Expand All @@ -95,6 +97,8 @@ sorted by the following categories:

.. _`Particles`: Particles_Tutorial.html

.. _`Python`: Python_Tutorial.html

.. _`SDC`: SDC_Tutorial.html

.. _`SENSEI`: SENSEI_Tutorial.html
Expand Down

0 comments on commit 86b73ba

Please sign in to comment.