Skip to content
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

Jump to bottom

Doc: Link More Examples #325

Merged
merged 1 commit into from
May 30, 2024
Merged

Doc: Link More Examples #325

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
5 changes: 5 additions & 0 deletions docs/source/usage/examples.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,16 @@ ImpactX

* `Python examples <https://impactx.readthedocs.io/en/latest/usage/examples.html>`__
* `Python implementation <https://github.com/ECP-WarpX/impactx/tree/development/src/python>`__
* Highlight example: `Fully GPU-accelerated PyTorch+ImpactX simulation <https://impactx.readthedocs.io/en/latest/usage/examples/pytorch_surrogate_model/README.html>`__


WarpX
"""""
`WarpX <https://warpx.readthedocs.io>`__ is an advanced, time-based electromagnetic & electrostatic Particle-In-Cell code.

* `Python (PICMI) examples <https://warpx.readthedocs.io/en/latest/usage/examples.html>`__
* `Python implementation <https://github.com/ECP-WarpX/WarpX/tree/development/Source/Python>`__
* Detailed workflow: `Extend a WarpX Simulation with Python <https://warpx.readthedocs.io/en/latest/usage/workflows/python_extend.html>`__


Standalone
Expand All @@ -52,3 +55,5 @@ We ensure the correctness of pyAMReX with `unit tests <https://en.wikipedia.org/
Our tests are small, plentiful and can be found in the source code, see:

* `tests/ <https://github.com/AMReX-Codes/pyamrex/tree/development/tests>`__

The following sections on :ref:`compute workflows <usage-compute>` go in detail through selected unit tests, too.
Loading