Skip to content

Commit

Permalink
Doc: Link More Examples (#325)
Browse files Browse the repository at this point in the history
  • Loading branch information
ax3l authored May 30, 2024
1 parent d4d409b commit ae75b5a
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/source/usage/examples.rst
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.

0 comments on commit ae75b5a

Please sign in to comment.