How to use tool

The command is

createpublicdb_imas

Run:

createpublicdb_imas --help

to get basic documentation.

Example usage

1. Create a text file with name description.txt that contains a plain-text description of the database you want to save
2. Run the tool in 'dry run mode first':

createpublicdb_imas -n <USER> <TOKAMAK> <DATAVERSION> <SHOT> <RUN> description.txt
createpublicdb_imas -n g2dfigat jet 3 12 12 description.txt

This will output the actions that will be taken and the metadata file that will be created on stdout.

1. Run the tool:

   Code Block
   createpublicdb_imas g2dfigat jet 3 12 12 description.txt

   
   

2. Check the output with imasdbs:

   Code Block
   imasdbs -u public -t jet -v 3

   This should now list the shot (in this case 12)

Test environment

The tools is meant to modify the public database, which carries the risk of corrupting important data.
For testing the tool, or practicing its use, a test environment is foreseen. In this test environment a test copy of the public database is used. Below are instructions how to use the test environment.

1. Switch to development environment

module purge
module load imasenv

2. check that you have the development database selected:

env | grep PUBLICDB

This should give:

IMASPUBLICDBDEVHOME=/pfs/work/imasdb_dev
IMASPUBLICDBDEVMETADATA=/pfs/work/imasdb_dev/meta
IMASPUBLICDBHOME=/pfs/work/imasdb_dev
IMASPUBLICDBMETADATA=/pfs/work/imasdb_dev/meta

IMPORTANT: If you don't check this, you risk overwriting the real public database!

3. run tool:

createpublicdb_imas --help

This should give you some basic documentation.

4. use tool to create entries in the public database

5. check that the public database is populated correctly:

imasdbs -u public

Please report any problems you find to the above tracker item.