Difference between revisions of "MCWrapper"

From GlueXWiki
Jump to: navigation, search
(Created page with " * [https://github.com/JeffersonLab/gluex_MCwrapper GitHub] * [https://www.overleaf.com/project/5bb7b3423bb4c259308b56c5] * How_to_choose_software_versions_on_the_MC_submiss...")
 
Line 1: Line 1:
 +
Generating simulated data that correctly matches the "real" data you are analyzing requires coordinating several different pieces of software with different inputs, which can be very complex to do correctly!  MCWrapper provides a framework to simulate events in GlueX that simplifies some of the complexity.
  
−
* [https://github.com/JeffersonLab/gluex_MCwrapper GitHub]
+
= Generating Simulations =
−
* [https://www.overleaf.com/project/5bb7b3423bb4c259308b56c5]
+
 
−
* [[How_to_choose_software_versions_on_the_MC_submission_form]]
+
The [https://github.com/JeffersonLab/gluex_MCwrapper MCWrapper] software can be run on a local batch farm or on the Open Science Grid (OSG) using [https://halldweb.jlab.org/gluex_sim/SubmitSim.html this website]. There is a  [https://www.overleaf.com/project/5bb7b3423bb4c259308b56c5 pdf manual], but it is not fully up-to-date.
 +
 
 +
 
 +
* Generally you should start by submitting MC requests via [https://halldweb.jlab.org/gluex_sim/SubmitSim.html the website].
 +
* Usually you will be generating simulations to study the efficiency for some reaction that you are measuring with data that has already been taken.  You want to use the latest versions of the simulation software, but the same software that was used to reconstruct the data, so that the simulated data matches the real data.  We keep up-to-date suggestions for which software sets to use for different data sets, [[How_to_choose_software_versions_on_the_MC_submission_form|follow these instructions]].
 +
* The efficiency depends on the beam intensity, and therefore is run-dependent.  You want to generate events spread out over the range of runs from a given data set.
 +
** Here are some common run ranges / RCDB requests:  (GlueX [https://halldweb.jlab.org/wiki-private/index.php/GlueX_Phase-I_Dataset_Summary Phase-I], [https://halldweb.jlab.org/wiki-private/index.php/GlueX_Phase-II_Dataset_Summary Phase-II])
 +
*** 2017-01: runs 30274 - 31057, RCDB query: "@is_production and @status_approved"
 +
*** 2018-01: runs 40856 - 42559, RCDB query: "@is_2018production and @status_approved"
 +
*** 2018-08: runs 50685 - 51768, RCDB query: "@is_2018production and @status_approved and beam_on_current>49"
 +
*** 2019-11: runs 71350-73266, RCDB query: "@is_dirc_production and @status_approved"
 +
* You also have to pass a configuration file for the [[Event_generators|event generator]] you are using.  Some example configuration files [https://github.com/JeffersonLab/gluex_MCwrapper/tree/master/Generators can be found here].  Another set of examples is here (should save some common examples).  Note that there are some dummy values for things like beam parameters that get filled in by the system.
 +
* After generating events, you can simulate additional particle decays using [[EvtGen]]
 +
* Always use Geant4 - the Geant3 option is kept for development purposes.
 +
* You probably want to have some PART trees to analyze.  Click the "Add Reaction" button to specify the same information that you supplied when requesting your analysis launch.
 +
** The analysis ROOT trees are made in a separate step from the data reconstruction, though they use the same software package (halld_recon).  Under the "analysis version set" tag, select the version listed for your analysis launch under the "Analysis Launches" tab in the [https://halldweb.jlab.org/wiki-private/index.php/Main_Page Private Wiki].
 +
* All of the files are saved on the JLab farm under /cache/halld/gluex_simulations/REQUESTED_MC
 +
 
 +
 
 +
= Managing Simulations =

Revision as of 15:28, 17 March 2022

Generating simulated data that correctly matches the "real" data you are analyzing requires coordinating several different pieces of software with different inputs, which can be very complex to do correctly! MCWrapper provides a framework to simulate events in GlueX that simplifies some of the complexity.

Generating Simulations

The MCWrapper software can be run on a local batch farm or on the Open Science Grid (OSG) using this website. There is a pdf manual, but it is not fully up-to-date.


  • Generally you should start by submitting MC requests via the website.
  • Usually you will be generating simulations to study the efficiency for some reaction that you are measuring with data that has already been taken. You want to use the latest versions of the simulation software, but the same software that was used to reconstruct the data, so that the simulated data matches the real data. We keep up-to-date suggestions for which software sets to use for different data sets, follow these instructions.
  • The efficiency depends on the beam intensity, and therefore is run-dependent. You want to generate events spread out over the range of runs from a given data set.
    • Here are some common run ranges / RCDB requests: (GlueX Phase-I, Phase-II)
      • 2017-01: runs 30274 - 31057, RCDB query: "@is_production and @status_approved"
      • 2018-01: runs 40856 - 42559, RCDB query: "@is_2018production and @status_approved"
      • 2018-08: runs 50685 - 51768, RCDB query: "@is_2018production and @status_approved and beam_on_current>49"
      • 2019-11: runs 71350-73266, RCDB query: "@is_dirc_production and @status_approved"
  • You also have to pass a configuration file for the event generator you are using. Some example configuration files can be found here. Another set of examples is here (should save some common examples). Note that there are some dummy values for things like beam parameters that get filled in by the system.
  • After generating events, you can simulate additional particle decays using EvtGen
  • Always use Geant4 - the Geant3 option is kept for development purposes.
  • You probably want to have some PART trees to analyze. Click the "Add Reaction" button to specify the same information that you supplied when requesting your analysis launch.
    • The analysis ROOT trees are made in a separate step from the data reconstruction, though they use the same software package (halld_recon). Under the "analysis version set" tag, select the version listed for your analysis launch under the "Analysis Launches" tab in the Private Wiki.
  • All of the files are saved on the JLab farm under /cache/halld/gluex_simulations/REQUESTED_MC


Managing Simulations

Retrieved from "https://halldweb.jlab.org/wiki/index.php?title=MCWrapper&oldid=111700"