This tutorial session is meant to make you familiar with ETS workflow. This session is not targeting details of computations. It's rather view from broader perspective. I want to show you how to install Kepler, load ETS, learn basics of custom IMAS related actors.
| Info |
|---|
Note that this part of tutorial is assumed to give you just an overview of all the components. We will not cover details here. It's supposed to give you the feeling of what is the target of this training and where we want to be after it is delivered. ETS (the workflow) itself is a topic for a broader discussion. |
Running ETS
In order to run ETS workflow you need few elements:
- terminal with IMAS environment loaded (will be discussed later)
- so called "dressed Kepler" - this is a dedicated version of Kepler with external actors (we will not cover it during this tutorial)
- workflow file (XML based file that describes how workflow is organised) - we will not cover details of ETS during this tutorial
Preparing environment for ETS execution
In order to load ETS I will perform few steps:
- load environment
- install Kepler
- start Kepler
- load workflow
| Warning | ||
|---|---|---|
| ||
Please note that in case you are not sure what environment is loaded you can always `purge` it
These two commands will bring you to the state with clean terminal session. |
In order to install and run ETS based Kepler we have to run following commands
| Code Block |
|---|
# Load IMAS environment - details will be discussed in other section
> module load imasenv/3.24.0/rc
# Switch to Kepler release with all the ETS actors
> module switch kepler/2.5p4-3.0.4_dressed
# Install your own copy of Kepler
> kepler_install my_ETS_Kepler
# Load the version you have just installed
# - note that users/developers can work with multiple versions
# of Kepler at the same time (e.g. released, being developed, etc.)
> kepler_load my_ETS_Kepler
# Start Kepler
> kepler |
Loading ETS workflow
In order to open workflow choose File → Open → /afs/gw/swimas/resources/tutorials/2019-12-PSNC/ETS/ETS_WORKFLOW_IMAS.xml and open file ETS_WORKFLOW_IMAS.xml - you should be able to see following workflow being loaded.
Kepler Core Actors (KCA) for IMAS
While analysing ETS workflow you will find lots of actors that are dedicated to IMAS itself. These actors perform (mostly) actions related to data input/output reading/writing. These actors are called Kepler Core Actors.
You can always refer to the list of all actors here: Kepler Core Actors - documentation
Repository with actors can be found at following location: Kepler Core Actors - GIT repository
During this session we will briefly go over the list of these actors to give you the feeling of what each actor does.
Building Physics related actors
In case you are supposed to release all the actors for ETS you have to run so called - actor release procedure. This term refers to running build script actor_install.py that will build all the actors.
| Warning |
|---|
Please note that in order to build all the actors you have to have access to all the repositories used during build procedure. This may required contacting individual developer (code developers) to gain access to the repository. |
| Code Block |
|---|
# First of all you have to checkout actor release repository
#
> svn co https://gforge6.eufus.eu/svn/actor_release/trunk/IMAS
> cd IMAS
# You have to initialise your environment
#
> module purge
> module load cineca
> module load imasenv/3.24.0/rc
# You should prepare the place where you Kepler installations will be stored.
#
> mkdir -p $ITMWORK/my_imas_keplers
> setenv KEPLER_DIR $ITMWORK/my_imas_keplers
> imasdb test
> setenv _JAVA_OPTIONS "-Xss20m -Xms8g -Xmx8g -Dsun.java2d.xrender=false"
# Now you can make sure to prepare new version of Kepler - where all the actors
# will be installed
#
> module switch kepler/2.5p4-3.0.4
> kepler_install test_kepler
> kepler_load test_kepler
> ./actor_install.py --skipModules -D install_folder -v debug |
Once above steps are executed, your Kepler release will contain all the physics related actors.