Skip to content

Change wording to Python installation instructions #160

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 21, 2025
Merged

Change wording to Python installation instructions #160

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions Docs/source/Python_Tutorial.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,14 @@ 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 pyamrex_pip_install``.
In order to run the Python tutorials, you need to have pyAMReX installed.
Please see `pyAMReX <https://github.com/AMReX-Codes/pyamrex/>`__ for more details.

Alternatively, you can build the ExampleCodes in this repository with ``-DTUTORIAL_PYTHON=ON`` added to the CMake configuration options,
then install with ``cmake --build build --target pyamrex_pip_install``, and pyamrex will be installed for you.

Guided Tutorial Examples:
Once pyAMReX is installed, you can run the following Guided Tutorial Examples:

- :download:`MultiFab <../../GuidedTutorials/MultiFab/main.py>`
- :download:`Heat Equation <../../GuidedTutorials/HeatEquation/Source/main.py>`

Please see `pyAMReX <https://github.com/AMReX-Codes/pyamrex/>`__ for more details.
Loading