{{indexmenu_n>4}}

[[:|<< back to HepSim manual]]

====== Using hs-toolkit ======
 

The package "hs-tools" is a light-weight framework to download ProMC files and run validation scripts. You can use Python to use this package. Here are a few
software components that are included in this tool:

  * [[http://www.jython.org/jythonbook/en/1.0/| Jython book]]
  * [[https://datamelt.org/| DataMelt (community version)]]
  * [[https://github.com/gavalian/groot/wiki| GRoot]]

====== Installing hs-toolkit ======

Install the hs-toolkit using the "bash" shell on Linux/Mac:

<code bash>
bash       # set to bash if needed   
wget https://atlaswww.hep.anl.gov/hepsim/soft/hs-toolkit.tgz -O - | tar -xz;
source hs-toolkit/setup.sh
</code>

This creates the directory "hs-toolkit" with HepSim commands.
[[https://www.java.com/en/download/|Java7/8]] and above should be installed. 
You can view the commands by typing:

<code bash>      
hs-help
</code>

This package is used for download, view and analyse HepSim files (truth-level only).  
To analyse (*.lcio) files with Geant4 simulations, use 
[[http://atlaswww.hep.anl.gov/asc/jas4pp | JAS4PP program]], which, in addition to hs-toolkit,
include more software component to work with LCIO files.
To analyse ROOT files with fast simulations, use Delphes/ROOT frameworks. 

<note tip>Note that you can also use the [[hepsim:dev_singularity|HepSim Singularity/Docker container]] with included
hs-tools commands</note>

====== Downloading files with  hs-toolkit ======

This topic was described in [[https://atlaswww.hep.anl.gov/hepsim/doc/doku.php?id=hepsim:usage_download|Downloading files]]

====== Analysing events with  hs-toolkit ======

This topic was described in [[https://atlaswww.hep.anl.gov/hepsim/doc/doku.php?id=hepsim:usage_analysis|Analysing events]]



====== Java API  hs-toolkit ======

See [[https://atlaswww.hep.anl.gov/hepsim/hepsimjar/api/|Java code API of hs-tools]].


====== Validation scripts ======

hs-toolkit is used to run the scripts located in [[https://atlaswww.hep.anl.gov/hepsim/macrolist.php|Validation macros]].

 --- //[[chekanov@anl.gov|Sergei Chekanov]] 2015/03/06 08:49//