Difference between revisions of "Software"

From GlueXWiki
Jump to: navigation, search
(48 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
This page provides a very brief overview of the GlueX-specific software used between recording data and publishing results.  
 
This page provides a very brief overview of the GlueX-specific software used between recording data and publishing results.  
In time, it should become populated with links to more detailed documentation.
+
In time, it should become populated with links to more detailed documentation..
  
  
'''Raw and reconstructed data – halld_recon'''
+
'''Databases and other tables''' are described [[HallD Databases|'''''here''''']]. ([mailto:nsj@cmu.edu Naomi], [mailto:sdobbs@fsu.edu Sean], [mailto:davidl@jlab.org David L.])
* <span style="color:red; font-size:2em">&#9679;</span> Raw data is saved in the [https://www.jlab.org/evio EVIO] file format and processed using programs in halld_recon. (Mark)
+
* There are three main databases:
+
** <span style="color:green; font-size:2em">&#9679;</span> Run conditions (e.g. beam current, radiator) are stored in [https://github.com/JeffersonLab/rcdb/wiki RCDB] ([https://halldweb.jlab.org/rcdb/runs/ web interface]) (Naomi)
+
** <span style="color:orange; font-size:2em">&#9679;</span> Calibrations and other parameters used in reconstruction/analysis are stored in [https://github.com/JeffersonLab/ccdb/wiki/ CCDB] ([https://halldweb.jlab.org/cgi-bin/ccdb/objects web interface]). (Naomi & Sean)
+
** <span style="color:green; font-size:2em">&#9679;</span> Hall-D Online Skim System records data for individual raw data files [https://halldweb.jlab.org/hoss HOSS] (e.g. number of events per file, number of each trigger type, ... ''n.b. only for 2020 and later Run Periods'')  (David)
+
* <span style="color:orange; font-size:2em">&#9679;</span> hd_root is used to analyse EVIO and REST data with plugins for monitoring, [[Calibrations]], and event reconstruction (Sean [calibrations] - & Mark)
+
* <span style="color:red; font-size:2em">&#9679;</span> REST files are an HDDM format which stores reconstructed physics objects (no detector hit information) (Richard)
+
  
  
'''Simulated data - halld_sim'''
+
'''Raw and reconstructed data '''[https://github.com/JeffersonLab/halld_recon/wiki '''halld_recon''']
* <span style="color:orange; font-size:2em">&#9679;</span> Simulated data are in [[HDDM_Programmer%27s_Interface | HDDM format]]. (Richard)
+
* <span style="color:orange; font-size:2em">&#9679;</span> Raw data are saved by the [https://coda.jlab.org/drupal/ '''''DAQ system'''''] in the [https://www.jlab.org/evio '''''EVIO'''''] file format (more details [https://coda.jlab.org/drupal/content/event-io-evio '''''here''''']) and processed using programs in [https://github.com/JeffersonLab/halld_recon/wiki '''''halld_recon''''']. (Mark)
* <span style="color:green; font-size:2em">&#9679;</span> [[Event generators]] generate simulated physics data (particle, momentum, track angle) (Simon & Malte)
+
* <span style="color:orange; font-size:2em">&#9679;</span> hd_root is used to analyse '''EVIO''' (see above) and '''REST''' (<span style="color:red">'''THIS NEEDS LINK'''</span>) data with plugins for monitoring, [[Calibrations|'''''Calibrations''''']], and event reconstruction ([mailto:sdobbs@fsu.edu Sean] [calibrations] - & Mark)
* <span style="color:red; font-size:2em">&#9679;</span> hdgeant4 models the measurements (detector hits) produced by those tracks (Richard)
+
* <span style="color:red; font-size:2em">&#9679;</span> '''REST''' files are in [https://halldweb.jlab.org/wiki/index.php/HDDM_Programmer%27s_Interface '''''HDDM format'''''] which stores reconstructed physics objects (no detector hit information) ([mailto:richard.t.jones@uconn.edu Richard])
* <span style="color:red; font-size:2em">&#9679;</span> mcsmear models the detector resolution which makes the measurements less exact. (Richard)
+
 
* <span style="color:orange; font-size:2em">&#9679;</span> [[How_to_choose_software_versions_on_the_MC_submission_form |MCWrapper]] runs the above on demand. (Sean)
+
 
 +
'''Simulated data  - halld_sim''' ([[Simulation_Software|Overview]])
 +
* <span style="color:green; font-size:2em">&#9679;</span> [[Event generators|'''''Event generators''''']] generate simulated physics data (particle, momentum, track angle) in [[HDDM_Programmer%27s_Interface |'''''HDDM format''''']]. ([mailto:staylor@jlab.org Simon] & [mailto:malte@jlab.org Malte]; [mailto:richard.t.jones@uconn.edu Richard])
 +
* <span style="color:red; font-size:2em">&#9679;</span> [https://github.com/JeffersonLab/HDGeant4 '''''hdgeant4'''''] models the measurements (detector hits) produced by those tracks ([mailto:richard.t.jones@uconn.edu Richard])
 +
* <span style="color:red; font-size:2em">&#9679;</span> mcsmear models the detector resolution to match the MC simulation results with actual measurements. ([mailto:richard.t.jones@uconn.edu Richard])
 +
* <span style="color:orange; font-size:2em">&#9679;</span> [[MCWrapper |'''''MCWrapper''''']] runs all of the above on demand. ([mailto:sdobbs@fsu.edu Sean])
  
  
 
'''Reaction channel analysis'''
 
'''Reaction channel analysis'''
* <span style="color:orange; font-size:2em">&#9679;</span>  ReactionFilter plugin is used to find the events corresponding to a particular reaction to make Analysis Trees. The basic ideas and steps are outlined [https://halldweb.jlab.org/wiki/index.php/ReactionFilter '''''here'''''](Beni)
+
* <span style="color:orange; font-size:2em">&#9679;</span>  ReactionFilter plugin is used to find the events corresponding to a particular reaction to make Analysis Trees. The basic ideas and steps are outlined [https://halldweb.jlab.org/wiki/index.php/ReactionFilter '''''here''''']([mailto:ijaegle@jlab.org Igal], [mailto:zihlmann@jlab.org Beni])
* <span style="color:green; font-size:2em">&#9679;</span> Requests for analysis trees are collected via a [https://halldweb.jlab.org/analysis/SubmitReaction.html '''''webpage'''''], and launched bundled together on the JLab farm. Lists for already existing trees are kept [https://halldweb.jlab.org/wiki-private/index.php/Spring_2017_Analysis_Launch '''''here''''']. (Alex A)
+
* <span style="color:green; font-size:2em">&#9679;</span> Requests for analysis trees are collected via a [https://halldweb.jlab.org/analysis/SubmitReaction.html '''''webpage'''''], and launched bundled together on the JLab farm. Lists for already existing trees are kept on the [https://halldweb.jlab.org/wiki-private/index.php/Main_Page Private wiki] under "Run Period Info" and "Analysis Launches", for example [https://halldweb.jlab.org/wiki-private/index.php/Spring_2017_Analysis_Launch '''''here''''']. ([mailto:aaustreg@jlab.org Alex A])
  
  
 
'''Analysis Tree analysis'''
 
'''Analysis Tree analysis'''
* <span style="color:orange; font-size:2em">&#9679;</span>  DSelectors are used to analyze "Analysis Trees" (see reaction filter above) to generate histograms of invariant mass etc. and generate highly reduced output trees for further analysis. [https://halldweb.jlab.org/wiki/index.php/Analyze_Analysis_Trees '''Analyze an Analysis Tree'''](Beni)
+
* <span style="color:orange; font-size:2em">&#9679;</span>  DSelectors are used to analyze "Analysis Trees" (see reaction filter above) to generate histograms of invariant masses, angular distributions and more. It can also generate highly reduced output trees for further analysis reducing the I/O. See [[Analyze Analysis Trees |'''''Analyze an Analysis Tree''''']] for more details. ([mailto:zihlmann@jlab.org Beni])
* <span style="color:green; font-size:2em">&#9679;</span> [[FSRoot]] is an alternative to DSelectors that uses flat trees. (Ryan)
+
* <span style="color:red">'''Other Analyses approaches like python code on flat trees?'''</span>  (Jon.Z, others)
* <span style="color:green; font-size:2em">&#9679;</span> AmpTools ([https://github.com/mashephe/AmpTools GitHub], [https://github.com/mashephe/AmpTools/blob/master/AmpTools_User_Guide.pdf User Guide]) is used for partial wave analysis. GlueX specifics are documented [https://halldweb.jlab.org/wiki-private/index.php/AmpTools_Fits_Best_Practices here (PRIVATE)]  (Malte)
+
* <span style="color:green; font-size:2em">&#9679;</span> [[FSRoot|'''''FSRoot''''']] is an alternative to DSelectors that uses flat trees. ([mailto:remitche@indiana.edu Ryan])
 +
* <span style="color:green; font-size:2em">&#9679;</span> AmpTools ([https://github.com/mashephe/AmpTools '''''GitHub'''''], [https://github.com/mashephe/AmpTools/blob/master/AmpTools_User_Guide.pdf '''''User Guide''''']) is used for partial wave analysis. GlueX specifics are documented [https://halldweb.jlab.org/wiki-private/index.php/AmpTools_Fits_Best_Practices '''''here (PRIVATE)''''']  ([mailto:malte@jlab.org Malte])
 +
* <span style="color:green; font-size:2em">&#9679;</span> [https://pypwa.jlab.org/ '''''PyPWA'''''] is an alternative software package to perform an amplituded analysis based on python. Documentation details can be found [https://pypwa.readthedocs.io/ '''''here'''''] (Carlos, Maj)

Revision as of 10:15, 6 July 2022

This page provides a very brief overview of the GlueX-specific software used between recording data and publishing results. In time, it should become populated with links to more detailed documentation..


Databases and other tables are described here. (Naomi, Sean, David L.)


Raw and reconstructed data – halld_recon

  • Raw data are saved by the DAQ system in the EVIO file format (more details here) and processed using programs in halld_recon. (Mark)
  • hd_root is used to analyse EVIO (see above) and REST (THIS NEEDS LINK) data with plugins for monitoring, Calibrations, and event reconstruction (Sean [calibrations] - & Mark)
  • REST files are in HDDM format which stores reconstructed physics objects (no detector hit information) (Richard)


Simulated data - halld_sim (Overview)


Reaction channel analysis

  • ReactionFilter plugin is used to find the events corresponding to a particular reaction to make Analysis Trees. The basic ideas and steps are outlined here(Igal, Beni)
  • Requests for analysis trees are collected via a webpage, and launched bundled together on the JLab farm. Lists for already existing trees are kept on the Private wiki under "Run Period Info" and "Analysis Launches", for example here. (Alex A)


Analysis Tree analysis

  • DSelectors are used to analyze "Analysis Trees" (see reaction filter above) to generate histograms of invariant masses, angular distributions and more. It can also generate highly reduced output trees for further analysis reducing the I/O. See Analyze an Analysis Tree for more details. (Beni)
  • Other Analyses approaches like python code on flat trees? (Jon.Z, others)
  • FSRoot is an alternative to DSelectors that uses flat trees. (Ryan)
  • AmpTools (GitHub, User Guide) is used for partial wave analysis. GlueX specifics are documented here (PRIVATE) (Malte)
  • PyPWA is an alternative software package to perform an amplituded analysis based on python. Documentation details can be found here (Carlos, Maj)