Overview

Teaching: 30 min
Exercises: 0 min

Questions

• What is the Run Conditions Table?

• What data is stored in this table?

• How to access the data?

Objectives

• Learn how to access and stream the data from tables in the conditions database by using the run conditions table as an example

The Run Conditions Table

The run conditions table is stored at the ProtoDUNE conditions database. It contains the conditions for each run, and the data can be accessed through various methods to suit different user needs.

Table information

As of now, the table contains the following metadata:

How to access the data

Curl command

There are several methods available for users to access the data of the run conditions table. The most straightforward way is to access the data with a curl command on the terminal or on the web.

What you need to know

1. The database url. For our example: https://dbdata0vm.fnal.gov:9443/dune_runcon_prod
2. The table name. For our example: pdunesp.run_conditionstest

curl "https://dbdata0vm.fnal.gov:9443/dune_runcon_prod/get?folder=pdunesp.run_conditionstest&t=28650"

The above example queries the conditions of run “25034” or the closest run to “25034”.

Remember

1. If the given run does not exists the previous query will return the closest run.
2. The column representing run number is called tv.

To get the conditions of a range of runs, for example [25100,25115] use the following query:

curl "https://dbdata0vm.fnal.gov:9443/dune_runcon_prod/get?folder=pdunesp.run_conditionstest&t0=28650&t1=28655"

Python API (Condb2)

Detailed documentation about the conditions database python REST API can be found in the condb2 webpage.

To use the API, it is necessary to install it, as it is explained in the webpage. Once that is done, it is recommended to use the condb2 web access python API, instead of the direct access. For the run conditions table, the url that must be provided is:

1. The database url: https://dbdata0vm.fnal.gov:9443/dune_runcon_prod
2. The table/folder name: pdunesp.run_conditionstest

The web access python API includes functions for retrieving and uploading data, as well as creating table and table versions. Detailed documentation on how to use these functions can be found in the web access python API webpage. To use the functions get_data or search_data it is not necessary to provide username or password, nevertheless they are required to use the function put_data. To get a valid username and password contact Ana Paula Vizcaya or Norm Buchanan from the database team.

c++ interface and art service

The run conditions table uses the c++ interface and art service of the conditions database mentioned in the conditions database of ProtoDUNE webpage.

It is located with the dunecalib service. The github repository is dunecalib. A presentation with information on how to use the run conditions c++ interface and service can be found here.

C++ interface

To start using run conditions parameters include the following header files on your c++ file

#include "dunecalib/ConInt/RunConditionsProtoDUNE.h"
#include "nuevdb/IFDatabase/Table.h"

and set up the table to upload

condb::RunConditionsProtoDUNE* runCond = new condb::RunConditionsProtoDUNE();
runCond->SetTableURL("https://dbdata0vm.fnal.gov:9443/dune_runcon_prod/");
runCond->SetTableName("pdunesp.run_conditionstest");
runCond->SetVerbosity(0); // How much output, (0,3) - (none, more)
runCond->SetRunNumber1(0); //Change if a range of runs is desired
runCond->UpdateRN(25034); //Run Number
//runCond->SetTag(gDBTag); // If database has more than one version
runCond->LoadConditionsT();

Now you are ready to load and use the conditions parameters! The following is just one example to output some conditions on the terminal:

condb::RunCond_t rc = runCond->GetRunConditions(run);
std::cout << "\tStart time = " << rc.start_time
            << "\n\tdata type = " << rc.data_type
            << "\n\trun Number/sofw = " << rc.run_number
  	        << "\n\tupload time = " << rc.upload_t
            << "\n\tsoftware version = " << rc.software_version
            << "\n\tstop_time = " << rc.stop_time 
            << "\n\tbuffer = " << rc.buffer
            << "\n\tac_couple = " << rc.ac_couple
            << "\n\trun type = " << rc.run_type << std::endl;

A complete example script can be found in: dunecalib/dunecalib/ConInt/getRunConditionsPDUNE.cc and that example can be run as follows:

getRunConditionsPDUNE -r 25016

art service

You can also opt to use an art service. A presentation with some information on how to use it can be found here. The source scripts are located in the git dunecalib git repository: dunecalib/dunecalib/ConIntServices.

Alert

This section needs more details

To set up the art service in your fhicl file. Include the header files:

#include "runconditions_pdune.fcl"

And then in services:

services:
{
   servicerun: @local::pdune_runconditions
}

That should run the run conditinos table service!

And the fcl file with the variables that can change, such as run number: dunecalib/dunecalib/ConIntServices/runconditions_pdune.fcl. There the url and name of the run conditions table are also specified:

BEGIN_PROLOG

pdune_runconditions :
{
  service_provider: "RunConditionsServicePDUNE"

  TableURL: "https://dbdata0vm.fnal.gov:9443/dune_runcon_prod/" 
  TableName: "pdunesp.test"
  RunNumber: 23302.0
  RunNumber1: 0
  DBTag:     "v1.1"
  Verbosity: 1
}

END_PROLOG

Metacat filter

The run conditions table also works as a filter in ProtoDUNE’s metadata catalog (Metacat) queries. With it, you can search for run files using parameters from the run conditions table as filters.

What you need to know

The run conditions table filter name, for metacat, is dune_runshistdb.

To use the filter in metacat to query files, follow the next steps.

1. Go to Metacat web interface
2. Click on the query option on the top of the webpage
3. Enter the query and run

The following is an example of a Metacat query to look for files of run 25016 where the run_type is PROD. This last condition looks at the data from the run conditions table.

filter dune_runshistdb() (files from hd-protodune:hd-protodune_25016) where runs_history.run_type = PROD

The first part contains the filter name ** dune_runshistdb. The code between () contains the dataset of files to look from (files from hd-protodune:hd-protodune_25016). And the final part contain the filter using the run condition parameter **runs_history.run_type = PROD.

Key Points

• There are several APIs available to access the information in the conditions database. Which to use depends on your specific needs.