Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents


How to use tool


Warning

These are just examples. The tool does not work yet.

...

Code Block
createpublicdb_imas


Run:



Code Block
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':

...

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

Code Block
module purge

...


module load imasenv

2. check that you have the development database selected:

Code Block
env | grep PUBLICDB

This should give:


Code Block
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:

Code Block
createpublicdb_imas --help

This should give you some basic documentation.

...

5. check that the public database is populated correctly:



Code Block
imasdbs -u public


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

...