Skip to content

Commit 9ebdc96

Browse files
authored
Update run_artemis.rst
1 parent 4e11074 commit 9ebdc96

File tree

1 file changed

+42
-4
lines changed

1 file changed

+42
-4
lines changed

Docs/source/usage/run_artemis.rst

Lines changed: 42 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,44 @@
1-
.. _usage_run:
1+
.. _running-artemis:
22

3-
Run ARTEMIS
4-
=========
3+
Running ARTEMIS
4+
===============
55

6-
Coming soon!
6+
This document demonstrates a few examples of how to **run ARTEMIS** after installation and compilation. Example input scripts reside in the ``Examples/`` directory.
7+
8+
1. Simple Testcase without LLG
9+
------------------------------
10+
11+
Below is an air-filled X-band rectangular waveguide simulation.
12+
13+
- **MPI + OpenMP Build**:
14+
15+
.. code-block:: bash
16+
17+
make -j 4 USE_LLG=FALSE
18+
mpirun -n 4 ./main3d.gnu.TPROF.MTMPI.OMP.GPUCLOCK.ex Examples/Waveguide/inputs_3d_empty_X_band
19+
20+
- **MPI + CUDA Build**:
21+
22+
.. code-block:: bash
23+
24+
make -j 4 USE_LLG=FALSE USE_GPU=TRUE
25+
mpirun -n 4 ./main3d.gnu.TPROF.MTMPI.CUDA.GPUCLOCK.ex Examples/Waveguide/inputs_3d_empty_X_band
26+
27+
2. Simple Testcase with LLG
28+
---------------------------
29+
30+
Below is a magnetically tunable X-band filter simulation.
31+
32+
- **MPI + OpenMP Build**:
33+
34+
.. code-block:: bash
35+
36+
make -j 4 USE_LLG=TRUE
37+
mpirun -n 8 ./main3d.gnu.TPROF.MTMPI.OMP.GPUCLOCK.ex Examples/Waveguide/inputs_3d_LLG_filter
38+
39+
- **MPI + CUDA Build**:
40+
41+
.. code-block:: bash
42+
43+
make -j 4 USE_LLG=TRUE USE_GPU=TRUE
44+
mpirun -n 8 ./main3d.gnu.TPROF.MTMPI.CUDA.GPUCLOCK.ex Examples/Waveguide/inputs_3d_LLG_filter

0 commit comments

Comments
 (0)