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.
Documentation 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 Confluence page.
The documentation can be manually generated by installing sphinx and running:
module load IMAS IMASPy MUSCLE3
python3 -m venv ./venv
. venv/bin/activate
pip install -e .[all]
make -C docs html- 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 setup script is provided with an installation of the necessary repositories. Make sure you have access rights to all the relevant codes. The setup script will detect if codes are not yet available and install the missing ones. It is also configurable to enable or disable the installation of specific codes. In case the installed codes are outdated, you can either update them by hand in the run/ folder or remove directories from the run/ folder and run the setup script again.
# install repos
bash pds_setup.shTest workflows can be run to check if everything is working as expected. These workflows can be used as a template for your own workflows.
# move to run folder where all the generated code is ignored by git
cd run/
# prepare base environment and loaded modules
source imas_base_env
# run test workflow of choice
muscle_manager --start-all ../ymmsl_files/test_sink_source_actor.ymmslExample cases for actual ITER scenarios can be run for validation of the PDS workflows.
The shell script currently assumes it is being run from the base directory of the PDS repository.
The different workflows are contained in the workflows directory.
The different scenarios for these workflows are contained in the workflows/<my_workflow>/scenarios directory.
To run a preconfigured workflow, run the run_workflow.sh file with the desired workflow and scenario as arguments.
Note that this way of running the PDS workflows will change in the future as more developments are being made.
# to enable tab completion of the workflows and scenarios
source completion.sh
# run test workflow of choice, in this case:
# workflow: torax-nice_self_consistent_transport
# scenario: 105084
bash run_workflow.sh torax_nice_self_consistent_transport 105084