Skip to content

Commit

Permalink
Docs: Link pyAMReX
Browse files Browse the repository at this point in the history
Link Python interfaces after Fortran interfaces.
  • Loading branch information
ax3l committed Oct 5, 2023
1 parent 8755645 commit 034569f
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 0 deletions.
13 changes: 13 additions & 0 deletions Docs/sphinx_documentation/source/Python_Chapter.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
.. role:: cpp(code)
:language: c++

.. _Chap:Python:

Python Interface
================


The core of AMReX is written in C++.
For users who want to write all of their programs in Python, or C++ application developers that like to add Python interfaces to their applications for scripting, rapid prototyping, code coupling and/or AI/ML workflows, many AMReX classes, functions and all data containers are now also available for `Knights Who Say "Ni!" <https://en.wikipedia.org/wiki/Knights_Who_Say_%22Ni!%22>`__ and `parselmouths <https://en.wikipedia.org/wiki/Magic_in_Harry_Potter#Parseltongue>`__.

Please see `pyAMReX <https://github.com/AMReX-Codes/pyamrex/>`__ (`manual <https://pyamrex.readthedocs.io>`__) for further details.
1 change: 1 addition & 0 deletions Docs/sphinx_documentation/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ Documentation on migration from BoxLib is available in the AMReX repository at D
LinearSolvers_Chapter
Particle_Chapter
Fortran_Chapter
Python_Chapter
EB_Chapter
TimeIntegration_Chapter
GPU_Chapter
Expand Down

0 comments on commit 034569f

Please sign in to comment.