Skip to content

pds 0.1.dev736+g5b484af50 documentation

IMAS PDS Manual

IMAS PDS Manual¶

The Pulse Design Simulator couples multiple different codes used to design a pulse, exchanging IMAS data through MUSCLE3.

Getting started¶

git clone https://github.com/iterorganization/IMAS-PDS.git
cd IMAS-PDS

module use /work/projects/pds/modules/all
module load PDS

bin/pds-create-case inverse_convergence 105073
sbatch bin/pds-run-case.sbatch cases/inverse_convergence_105073

Installing PDS describes what the module sets up, Running a case, what a case contains and where its output goes, and Available workflows which couplings are available.

PDS couples different codes, so most of what you will need to read is maintained elsewhere. Below is an overview of what each tool does here, and where its own documentation and training live.

MUSCLE3 and coupling¶

Module	Role in PDS	Documentation
`IMAS-MUSCLE3`	Collection of helper actors and for working with IMAS data in MUSCLE3 simulations.	Documentation, Training
`MUSCLE3`	The coupling framework itself: it starts the actors, connects their ports and carries the messages between them.	Documentation, Training
`yMMSL`	The file format a workflow is written in.	Documentation
`MUSCLE3 dashboard`	Follows a running MUSCLE3 workflow live, and shows the recorder plots.	Repository
`ymmsl2svg`	Renders a MUSCLE3 workflow's coupling graph as SVG.	Repository

IMAS and data¶

Module	Role in PDS	Documentation
`IMAS Data Dictionary`	The data model itself: which IDSs exist and what is in them.	Documentation
`IMAS-Python`	Reading and writing the IMAS data that flows between the actors using Python.	Documentation, Training
`IMAS-Validator`	Rule-based checks on IDS contents; PDS uses it for the operational limit checks.	Documentation, Training

Physics codes and pulse design¶

Module	Role in PDS	Documentation
`NICE`	Free-boundary equilibrium, in inverse, direct and evolutive (resistive diffusion) mode.	Documentation
`TORAX`	A core transport solver.	Documentation
`TORAX-MUSCLE3`	The MUSCLE3 actor wrapping TORAX, with its IMAS couplings.	Documentation
`METIS-IRFM`	Fast integrated transport that does a whole pulse on its own.	Repository (ITER internal), Documentation
`Waveform-Editor`	Turns a `waveforms.yaml` into the target waveforms the solvers are driven with, and carries the machine description.	Documentation, Training
`PCS`	The PCSSP magnetic controller (MATLAB/Simulink).	Repository (ITER internal)
`CHEASE`	Fixed-boundary equilibrium.	Repository

New to all of this? The trainings are the fastest way in: start with the PDS training.

IMAS PDS is licensed under LGPL-3.0-or-later. The source is on GitHub.