Skip to content

Commit 4e11074

Browse files
authored
Update artemis.rst
1 parent f359e8b commit 4e11074

File tree

1 file changed

+9
-52
lines changed

1 file changed

+9
-52
lines changed

Docs/source/install/artemis.rst

Lines changed: 9 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -27,19 +27,19 @@ Installation
2727
2828
git clone git@github.com:AMReX-Microelectronics/artemis.git
2929
30-
Make sure `amrex/` and `artemis/` are placed alongside each other in your filesystem.
30+
Make sure ``amrex/`` and ``artemis/`` are placed alongside each other in your filesystem.
3131

3232
3. **Build ARTEMIS**:
3333

34-
1. Navigate to the `Exec/` folder inside `artemis/`.
35-
2. Build with `make -j 4`, for example:
34+
1. Navigate to the ``Exec/`` folder inside ``artemis/``.
35+
2. Build with ``make -j 4``, for example:
3636

3737
.. code-block:: bash
3838
3939
cd artemis/Exec/
4040
make -j 4
4141
42-
By default, *LLG* is enabled (`USE_LLG = TRUE`). You can explicitly switch it on/off:
42+
By default, *LLG* is enabled (``USE_LLG = TRUE``). You can explicitly switch it on/off:
4343

4444
- **Without LLG**:
4545

@@ -53,55 +53,12 @@ Installation
5353
5454
make -j 4 USE_LLG=TRUE
5555
56-
To enable GPU acceleration (CUDA/HIP, etc.) set `USE_GPU=TRUE` in the make command. Check the `GNUmakefile` or other build scripts for additional optional flags like MPI, OpenMP, etc.
57-
58-
Running ARTEMIS
59-
---------------
60-
61-
**Example Input Scripts** reside in the `Examples/` directory. Below are a couple of quick start demonstrations.
62-
63-
.. _artemis-no-llg:
64-
65-
1. **Simple Testcase without LLG**
66-
67-
For an air-filled X-band rectangular waveguide simulation:
68-
69-
- *MPI + OpenMP Build*:
70-
71-
.. code-block:: bash
72-
73-
make -j 4 USE_LLG=FALSE
74-
mpirun -n 4 ./main3d.gnu.TPROF.MTMPI.OMP.GPUCLOCK.ex Examples/Waveguide/inputs_3d_empty_X_band
75-
76-
- *MPI + CUDA Build*:
77-
78-
.. code-block:: bash
79-
80-
make -j 4 USE_LLG=FALSE USE_GPU=TRUE
81-
mpirun -n 4 ./main3d.gnu.TPROF.MTMPI.CUDA.GPUCLOCK.ex Examples/Waveguide/inputs_3d_empty_X_band
82-
83-
2. **Simple Testcase with LLG**
84-
85-
For an X-band magnetically tunable filter simulation:
86-
87-
- *MPI + OpenMP Build*:
88-
89-
.. code-block:: bash
90-
91-
make -j 4 USE_LLG=TRUE
92-
mpirun -n 8 ./main3d.gnu.TPROF.MTMPI.OMP.GPUCLOCK.ex Examples/Waveguide/inputs_3d_LLG_filter
93-
94-
- *MPI + CUDA Build*:
95-
96-
.. code-block:: bash
97-
98-
make -j 4 USE_LLG=TRUE USE_GPU=TRUE
99-
mpirun -n 8 ./main3d.gnu.TPROF.MTMPI.CUDA.GPUCLOCK.ex Examples/Waveguide/inputs_3d_LLG_filter
56+
To enable GPU acceleration (e.g., CUDA), set ``USE_GPU=TRUE`` in the make command. Check the ``GNUmakefile`` or other build scripts for additional optional flags like MPI, OpenMP, etc.
10057

10158
Visualization and Data Analysis
10259
-------------------------------
10360

104-
ARTEMIS uses the AMReX I/O format for storing simulation results. You can use tools such as `VisIt`, `ParaView`, or other readers compatible with AMReX plotfiles.
61+
ARTEMIS uses the AMReX I/O format for storing simulation results. You can use tools such as `VisIt <https://wci.llnl.gov/simulation/computer-codes/visit>`_, `ParaView <https://www.paraview.org/>`_, or other readers compatible with AMReX plotfiles.
10562

10663
Additionally, `yt <https://yt-project.org/>`_ can be used in Python to load the data for advanced post-processing:
10764

@@ -115,15 +72,15 @@ Additionally, `yt <https://yt-project.org/>`_ can be used in Python to load the
11572
Publications
11673
------------
11774

118-
- **Z. Yao, R. Jambunathan, Y. Zeng and A. Nonaka**,
75+
- **Z. Yao, R. Jambunathan, Y. Zeng, and A. Nonaka**,
11976
A massively parallel time-domain coupled electrodynamics–micromagnetics solver.
12077
*The International Journal of High Performance Computing Applications*, 2022;36(2):167-181.
12178
`doi:10.1177/10943420211057906 <https://doi.org/10.1177/10943420211057906>`_
12279

123-
- **S. S. Sawant, Z. Yao, R. Jambunathan and A. Nonaka**,
80+
- **S. S. Sawant, Z. Yao, R. Jambunathan, and A. Nonaka**,
12481
Characterization of transmission lines in microelectronic circuits using the ARTEMIS solver,
12582
*IEEE Journal on Multiscale and Multiphysics Computational Techniques*, vol. 8, pp. 31-39, 2023,
126-
`doi: 10.1109/JMMCT.2022.3228281 <https://doi.org/10.1109/JMMCT.2022.3228281>`_
83+
`doi:10.1109/JMMCT.2022.3228281 <https://doi.org/10.1109/JMMCT.2022.3228281>`_
12784

12885
- **R. Jambunathan, Z. Yao, R. Lombardini, A. Rodriguez, and A. Nonaka**,
12986
Two-fluid physical modeling of superconducting resonators in the ARTEMIS framework,

0 commit comments

Comments
 (0)