IMAS PDS is an integrated modeling tool.
It is licensed under the GNU Lesser General Public License v3.0 or later
(LGPL-3.0-or-later); see LICENSE.md, COPYING.LESSER
and COPYING for details.
Installation guide can be found here Note that the IMAS PDS repository currently functions as a hub for combining different codes and tools, and does not need an installation of its own to function. The PDS tool is currently set up to be used on SDCC and needs significant manual tweaking to be able to run locally.
- PDS: Pulse Design Simulator workflow files
- IMAS-M3: General utility MUSCLE3 actors
- WAVEFORM-EDITOR: Generate pre built waveform data
- NICE: Free Boundary Equilibrium code
- METIS: Transport code
- TORAX: Transport code
- TORAX-M3: MUSCLE3 actor for TORAX
- CHEASE: Fixed-boundary axisymmetric tokamak equilibrium code
A run pairs a workflow (how it is simulated, in workflows/) with a scenario (what
is simulated, in the separate pds-scenarios repository). bin/pds-create-case
materializes that pairing as a case directory under cases/.
These premade cases are examples that can be built upon. The user is free to change anything in the
case directory. bin/pds-run-case.sbatch is then used to run the case using a Slurm job:
# PDS_REPO before the module load: without it the PDS module only finds the
# checkout when it happens to be your current directory.
export PDS_REPO=/path/to/pds
export SCENARIOS_REPO=/path/to/pds-scenarios
module use /work/projects/pds/modules/all
module load PDS
bin/pds-create-case inverse_convergence 105073
bin/pds-run-case cases/inverse_convergence_105073Documentation is autogenerated from the source using Sphinx and can be found here. To find more information about available muscle3 actors and how to use them, see the documentation of the actor's own repository.
The documentation can be manually generated by installing sphinx and running:
pip install uv # skip if you already have uv
uv venv
source .venv/bin/activate
uv sync --extra docs # or --all-extras
make -C docs html