Quote of the day:
I love the smell of broken configuration in the morning ...
- Anonymous tutorial lecturer
In this tutorial
- installation and configuration of MDSPlus databases
Table of Contents |
---|
Warning
Stop here for a moment. Make sure you have followed the configuration setup before proceeding any further!
Configuration related tutorial is here -> Click me! <-
1.1. 2.1. MDSPlus database
MDSplus is a set of software tools for data acquisition and storage and a methodology for management of complex scientific data (source).
In order to benefit from UAL layer, scientific data must be stored in MDSPlus database. Before you will be able to use it, you have to create database's structure. This is fairly simple. All you have to do is to execute following commands:
imasdb <machine_name>
At this point, you can check your public directory and browse through the database structure.
cd $HOME/public/imasdb/
Explanation of the tree structure:
location | description |
---|---|
$HOME/public/itmdb/<machine_name>/<data_version>/<MDSPlus_tree_number>/ids_<shot><run>.* example: ~/public/imasdb/test/3/0/ids_120001.* | |
<machine_name> example: test | defines the equipment used for acquiring the results; "test" - is most commonly used for artificial, test data |
<data_version> example: 3 | Major Data Dictionary version |
<MDSPlus_tree_number> example: 0 | Contains all the shot and runs for given data tree |
Run number | Run number is represented by last four digits in database file ids_SSSSRRRR.* |
Shot number | Shot number is represented by first digits in database file ids_SSSSRRRR.*; there is no limit for number of digits used |
ids_####.datafile, ids_####.tree, ids_####.characteristics | Contains data for given shot/run |
1.2. 2.2. Accessing MDSPlus database data
From the user's point of view, there are few characteristics that define single data tree:
Parameter | Environment variable | Description |
---|---|---|
User name | $USER | Defines the name of the user who owns the data |
Tokamak name | $TOKAMAKNAME | Defines the name of the machine that was used during simulation (test - contains testing data) |
UAL database version | $DATAVERSION | Specifies UAL data version |
Run number | not defined | Run number is represented by last four digits in database file ids_SSSSRRRR.* |
Shot number | not defined | Shot number is represented by first digits in database file ids_SSSSRRRR.*; there is no limit for number of digits used |
ITMv2 script
All above environment variables are set to default values whenever imasdb script is executed
imasdb <machine_name>
1.2.1.1. 2.2.1 Listing pulse files
itmdbs command
Usage: itmdbs [OPTIONS] [COMMAND]
This program lists existing ITM databases.
Possible commands are:
list <shot number>- list existing databases
slices <shot number> <run number> - list existing databases, including number of timeslices and time range for time-dependent IDSes
times <shot number> <run number> - list existing databases, including number of timeslices their time points for time-dependent IDSes
tokamak - list existing tokamaks (with data versions)
dataversion - list existing dataversions (with tokamaks)
If the optional arguments shot number and run number are given, only databases with these numbers will be shown.
If no command is given, the list command is performed.
To see databases stored in the public itm database, use 'public' as the user name.
Options:
-h, --help show this help message and exit
-u USER, --user=USER Show databases of specified user
-t TOKAMAK, --tokamak=TOKAMAK
Show only databases for specified tokamaks
-v VERSION, --version=VERSION
Show only databases for specified data version
--backend=BACKEND Show databases written with given backend(s). Comma-
separated list of backends (Currently supported:
mdsplus, hdf5). By default all backends are shown.
-c, --compact Compact/reduced output
shell> itmdbs -t test slices 14 4 Tokamak: test Data version: 4.10b UAL Backend: mdsplus Shot 14 Run: 4 equilibrium: 100 slices ( 0.0 - 99.0)
1.2.1.2. 2.2.2 Copying database files directly
In case you know user name, machine name, shot number and run number, you can import users' database files copying them directly from the users' public directories. Database files are located inside:
~$USERNAME/public/itmdb/itm_trees/$TOKAMAKNAME/$DATAVERSION/mdsplus/0/ids_SSSSRRRR.*
Take a look at the example below. We will copy data from user michalo, machine test, shot: 12 and run: 2
# change directory in your $HOME cd $HOME/public/itmdb/itm_trees/test/4.10b/mdsplus/0/ # copy data files (pay attention to *_dot_* at the end of command line!) cp ~michalo/public/itmdb/itm_trees/test/4.10b/mdsplus/0/ids_120002.* . cp ~michalo/public/itmdb/itm_trees/test/4.10b/mdsplus/0/ids_130003.* .