Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
hepsim:dev_tags [2017/09/05 19:39] hepsim17 |
hepsim:dev_tags [2017/09/13 21:22] (current) hepsim17 |
||
---|---|---|---|
Line 4: | Line 4: | ||
====== Submitting tags ====== | ====== Submitting tags ====== | ||
+ | As a HepSim user, you can submit your detector description and the simulation/ | ||
- | ===== Reconstruction tags ===== | + | All detector simulations |
- | + | small (<5 MB) files that include necessary information to convert truth-level files to final reconstructed events. All tags | |
- | + | ||
- | Full detector simulations are created using the concept of tags, which are | + | |
- | small (<3MB) files that include necessary information to convert truth-level files to final reconstructed events. All tags | + | |
can be found in [[http:// | can be found in [[http:// | ||
- | In many cases we call them " | + | In many cases we call them " |
A reconstruction tag is associated with the file with the name **rfull[XXX].tgz**, | A reconstruction tag is associated with the file with the name **rfull[XXX].tgz**, | ||
Line 24: | Line 22: | ||
* defining the tag name to be used for downloading events | * defining the tag name to be used for downloading events | ||
* defining the workflow of the simulation-reconstruction steps | * defining the workflow of the simulation-reconstruction steps | ||
- | * creating the necessary files for event visualization using Jas4pp | + | * creating the necessary files for event visualization using Jas4pp |
+ | * feeding the HPC and grid jobs for simulation and reconstruction (for dockers & singularity images). | ||
Reconstruction tags have unique names. There can be several reconstruction tags corresponding to a single detector, since simulation and reconstruction can be done using different software. | Reconstruction tags have unique names. There can be several reconstruction tags corresponding to a single detector, since simulation and reconstruction can be done using different software. | ||
- | They are small files that are sourced by reconstruction software on grid or HPC. A file "rfull[XXX].tgz" | + | They are small files that are sourced by reconstruction software on grid or HPC. A file **rfull[XXX].tgz** |
has everything you need to create LCIO/ROOT files with reconstructed events. | has everything you need to create LCIO/ROOT files with reconstructed events. | ||
+ | |||
+ | |||
+ | ====== Structure of tags ====== | ||
In most cases, the directory inside rfull[XXX].tgz has this structure (for a detector called " | In most cases, the directory inside rfull[XXX].tgz has this structure (for a detector called " | ||
Line 38: | Line 40: | ||
..... # other required files if needed | ..... # other required files if needed | ||
sifcch7 | sifcch7 | ||
- | - compact.xml | + | - compact.xml |
- | - other.xml ... # some other XML files with detector components | + | - other.xml ... # some other XML files with detector components |
- | - sifcch7.heprep | + | - sifcch7.heprep |
- | - sifcch7.lcdd | + | - sifcch7.lcdd |
- | - sifcch7.pandora # optional | + | - sifcch7.pandora # file for Pandora |
- | - sifcch7.json | + | - sifcch7.json |
- | - sifcch7.root | + | - sifcch7.root |
- | - sifcch7.html | + | - sifcch7.html |
- | - view1.png | + | - view1.png |
- | - view2.png | + | - view2.png |
- some config files | - some config files | ||
</ | </ | ||
Line 59: | Line 61: | ||
<note important> | <note important> | ||
when the tag files are sourced by reconstruction software on each node on HPC or grid, | when the tag files are sourced by reconstruction software on each node on HPC or grid, | ||
- | which are assumed to contain the needed software used in combination with **rfullXXX.tgz** files. | + | which are assumed to contain the needed software used in combination with **rfull[XXX].tgz** files. |
</ | </ | ||
You should create the reconstruction tag if: | You should create the reconstruction tag if: | ||
- | * detector geometry was changed. In this case, use a different detector name inside | + | * detector geometry was changed. In this case, use a different detector name inside |
* detector geometry is the same, but configuration files and setup scripts were changed. | * detector geometry is the same, but configuration files and setup scripts were changed. | ||
- | HepSim provides a mechanism for uploading rfull[XXX].tgz files. After upload, HepSim automatically extracts the | + | HepSim provides a mechanism for uploading |
- | detector from rfull[XXX].tgz and builds an information detector page. Then you will see two entries: | + | detector from **rfull[XXX].tgz** and builds an information detector page. Then you will see two entries: |
* [[http:// | * [[http:// | ||
* [[http:// | * [[http:// | ||
- | As mentioned before, we leave the authors with the liberty to design the rfull[XXX].tgz files. The only strict requirement is that they should have the directory with the detector description, | + | As mentioned before, we leave the authors with the liberty to design the **rfull[XXX].tgz** files. The only strict requirement is that they should have the directory with the detector description, |
The simulation and reconstruction scripts can include all the required | The simulation and reconstruction scripts can include all the required | ||
workflow to work together with the installed software (git, makefiles, wget commands etc). | workflow to work together with the installed software (git, makefiles, wget commands etc). | ||
<note tip> | <note tip> | ||
- | A tag file should have a directory with the detector name, and the "compact.xml" | + | A tag file should have a directory with the detector name, and the **compact.xml** file inside this directory. This structure helps automatically extract the detector for inclusion in HepSim. |
- | Please add compact.xml even if it is a dummy file not used for detector description.</ | + | Please add **compact.xml** even if it is a dummy file not used for detector description.</ |
After a tag file is uploaded, HepSim performs the following operations with this file: | After a tag file is uploaded, HepSim performs the following operations with this file: | ||
Line 91: | Line 93: | ||
First, request the account [[https:// | First, request the account [[https:// | ||
- | Then, go to [[http:// | + | Then, go to [[http:// |
--- // | --- // |