<note important>This manual is outdated. Please use 
http://atlaswww.hep.anl.gov/hepsim/doc/doku.php
</note>

 ====== HepSim manual ======

[[http://atlaswww.hep.anl.gov/hepsim/ | HepSim]] is a public repository with Monte Carlo simulated events for high-energy physics (HEP) experiments.
The [[http://atlaswww.hep.anl.gov/hepsim/ | HepSim repository]] was started at ANL during the US long-term planning study of the American Physical Society’s Division of Particles and Fields (Snowmass 2013) with  the goal to create references to  truth-level  MC records for current and future experiments. Event data samples are created using:

  * BlueGene/Q supercomputer of the Argonne Leadership Computing Facility ([[hpc:bghep:start|BG@HepLib]] library)
  * [[https://portal.ci-connect.net/|OSG (Open Science Grid) Connect]] ("FutureColliders" project). 
  * ATLAS Connect virtual cluster service ("ATLAS CI" project)
  * Argonne’s Laboratory Computing Resource Center (LCRC) ("HepSim" project)
  * ATLAS Analysis support (ASC) cluster at HEP/ANL

The file storage is provided by:

  * STASH2 storage at OSG CI Connect
  * FAXBOX storage at ATLAS Connect
  * [[https://www.nersc.gov/users/science-gateways/|NERSC science gateways]]
  * MC.HEP server at ASC ANL

This repository was created following
the guidelines and principles of the
[[http://www.energy.gov/sites/prod/files/2014/08/f18/DOE_Public_Access%20Plan_FINAL.pdf|DOE Public Access Plan]]
for unclassified and otherwise unrestricted scientific data in digital formats.

====== For HepSim users ======
{{:hpc:bghep:bghep1.png?1600x20|HepSim manual:For HepSim users }}

If you are a HepSim user, start from here.

  * [[community:hepsim:usage_download| How to find, view and download data]]
  * [[community:hepsim:usage_truth| How to perform data analysis using truth-level files]]
  * [[community:hepsim:usage_analysis| HepSim analysis tutorial]]
  * [[community:hepsim:usage_fast| How to analyse fast simulations]]
  * [[community:hepsim:usage_full| How to analyse full (Geant4) simulations]]
  * [[asc:jas4pp|Jas4pp introduction]]
  * [[community:hepsim:usage_view| Visualizing events]]
  * [[community:hepsim:usage_detectors| Detector descriptions and reconstructed tags]]


======  Physics and detector studies  ======
{{:hpc:bghep:bghep1.png?1600x20|HepSim manual:Physics and detector studies}}

Here are several links to extending this Wiki for particular detector-performance topics:
 

  * [[fcs:fcchh:|FCC-hh detector studies]] - explains how to analyses data for FCC-hh detector studies
  * [[fcs:sid:|SID detector studies]] - explains how to analyses data for the SiD detector (ILC)
  * [[fcs:cepc:|CEPC detector studies]] - shows some results with full simulations for CEPC
  * [[fcs:eic:|EIC detector studies]] - shows some results with full simulations for EIC
  * [[vlhc:hcal|HCAL studies]] explains how to analyse ROOT data after fast detector simulations used for FCC studies


====== For developers ======
{{:hpc:bghep:bghep1.png?1600x20|HepSim manual:For developers}}

If you plan to contribute to HepSim (Monte Carlo events, data storage etc), start from here:

  * [[community:hepsim:dev_truth | Creating truth-level samples]]
  * [[community:hepsim:dev_fast | Creating fast detector simulations]]
  * [[community:hepsim:dev_full | Creating full (Geant4) detector simulations]]
  * [[community:hepsim:dev_hepsim | Making a mirror or publishing your files]]
  * [[community:hepsim:pgun | Single particle guns]]
  * [[community:hepsim:dev_opentasks | Open tasks]]

====== Public results and contributions ======
{{:hpc:bghep:bghep1.png?1600x20|HepSim manual:Public results and contributions}}


===== Public results =====


  * [[https://atlaswww.hep.anl.gov/asc/wikidoc/doku.php?id=community:hepsim:public|List with pubic results based on HepSim]]


===== Contributions =====


  * [[https://atlaswww.hep.anl.gov/asc/wikidoc/doku.php?id=community:hepsim:contributions| List with contributions to the HepSim repository]]


====== How to cite ======
{{:hpc:bghep:bghep1.png?1600x20|HepSim manual:For HepSim users }}

If you use HepSim event samples, Python/Jython analysis scripts and output XML files in  your research, talks or
publications, please cite this project as:


S.V. Chekanov. //HepSim: a repository with predictions for high-energy physics experiments//. Advances in High Energy Physics, vol. 2015, ID136093, 2015. [[http://arxiv.org/abs/1403.1886 | arXiv:1403.1886]]  and [[http://www.hindawi.com/journals/ahep/2015/136093/|link]]. 

<hidden Click here to display BibTeX article entry>
<code bibtex>
@article{Chekanov:2014fga,
      author         = "Chekanov, S.V.",
      title          = "{HepSim: a repository with predictions for high-energy physics experiments}",
      year           = "2015",
      eprint         = "1403.1886",
      journal        = "Advances in High Energy Physics",
      volume         = "2015",
      pages          = "136093",
      archivePrefix  = "arXiv",
      primaryClass   = "hep-ph",
      note           = {Available as \url{http://atlaswww.hep.anl.gov/hepsim/}}
}
</code>
</hidden>


====== Acknowledgement ======
The current work  is supported  UChicago Argonne, LLC,
Operator of Argonne National Laboratory (``Argonne'').
Argonne, a U.S. Department of Energy Office of Science laboratory,
is operated under Contract No. DE-AC02-06CH11357.
This research used resources of the Argonne Leadership Computing Facility at Argonne National Laboratory, which is supported by the Office of Science of the U.S. Department of Energy under contract DE-AC02-06CH11357.


 --- //[[chekanov@anl.gov|Sergei Chekanov]] 2016/04/29 16:24//