Differences

This shows you the differences between two versions of the page.

--- community:hepsim:dev_hepsim [2016/10/25 22:40] – asc
+++ community:hepsim:dev_hepsim [2016/12/22 15:53] (current) – [Summary] asc
@@ Line 3: / Line 3: @@
 ====== How to link private samples to HepSim ======
-Your files can be  published on HepSim and you  can maintain your own Hepim repository with PROMC/SLCIO/ROOT files. This is useful if:
+Your files can be  published on [[http://atlaswww.hep.anl.gov/hepsim/|HepSim]] and you  can maintain your own HepSim repository with PROMC/SLCIO/ROOT files. This is useful if:
   * You want to share your own files, so they will be available from HepSim
-  * You want to copy your dataset to mirrors in other places
+  * You want to make a  mirror of data on a server close to your location for faster download
-  * You want to make a copy of certain HepSim datasets since the network connection to the existing mirrors is slow
-If the dataset is new, you will see a new entry in the HepSim database.
-If you have made a mirror, your server will be added as a mirror for a given dataset.
-Your authorship will be preserved inside HepSim web page.
+If the dataset is new, you will see a new entry in the HepSim database. Your authorship will be preserved on the HepSim web page.
+If you have made a mirror of the existing data, your server will be added as a mirror for a given dataset.
 ====== What do you need ======
@@ Line 18: / Line 17: @@
 You need the following:
-  * A web server that can hold your data (>1 TB is recommended)
+  * A web server that can hold your data (>1 TB for /var/www/html is recommended). It is advisable to create a separate partition with RAID10, say, /data, and link this directory to /var/www/html/.
   * Linux OS (any flavor)
-  * Installed Apache2 with PHP module and Java
+  * Apache2 with PHP module that can serve/var/www/html/
+  * Java 8 JDK or JRE (optionally, for tools to check data)
-The root directory of a typical HepSim repository is called "events". This directory should
+The root directory of a typical HepSim repository has the name  "events". This directory should
-be served by Apache. You will need to make the directory structure such as:
+be served by Apache, i.e. it should be visible from /var/www/html. You will need to make the directory structure such as:
-<code>
+<code bash>
-  |-events
+  |-events               # HepSim root directory
-  |  |-pp
+  |  |-pp                # process type: pp, ee, ep, misc (single particles)
-  |  |  |-14tev
+  |  |  |-14tev          # CM energy. Can be 100tev, 250gev, 500gev
-  |  |  |  |-qcd_pythia8
+  |  |  |  |-qcd_pythia8 # this directory contains ProMC files for EVGEN
-  |  |  |  |  |-rfast001
+  |  |  |  |  |-rfast001 # subdirectory with ROOT/Delphes files
-  |  |  |  |  |-rfull001
+  |  |  |  |  |-rfull001 # subdirectory with SLCIO files
-  |  |  |  |  |-macros
+  |  |  |  |  |-macros   # files for truth validation (optional)
 </code>
 (it shows a data sample for 14 TeV pp with the name "qcd_pythia8").
@@ Line 71: / Line 71: @@
 In both cases, make sure that Linux system administrator set correct permission for the directory "events", so you can copy the files. The directory for indexing should be inside your private directory outside the Web area.
-If you have indexed the files successfully, send a request to "[email protected]" (or [email protected]) to include your repository to HepSim database. Please include a short description of your files and your name.
+If you have indexed the files successfully, send a request to "[email protected]" (or [email protected]) to include your repository to HepSim database. Please include a short description of your files and your name (it will be shown on the web page).
+====== How to mirror entire dataset ======
+You can mirror an entire dataset by copying HepSim files to your mirror web server (or local computer).
+You can use the command "hs-mirror" from the "hs-toolkit" package. For example, if you want
+to mirror a dataset with known URL, use this example:
+<code bash>
+wget http://atlaswww.hep.anl.gov/hepsim/soft/hs-toolkit.tgz -O - | tar -xz;
+source hs-toolkit/setup.sh # setup HepSim programs
+# now copy a dataset from URL to a new location
+SOURCE=http://cepcgit.ihep.ac.cn:81/hepsim/events/ee/250gev/pythia6_higgs_gamgam_test
+OUTPUT_DIR=/var/www/html/
+hs-mirror -i $SOURCE-o $OUTPUT_DIR
+</code>
+This example creates the directory "/var/www/html/events/ee/250gev/pythia6_higgs_gamgam_test" and copies all files from the
+URL. The URL can be found using the HepSim web page.
+If you want to download only EVGEN files, without reconstructed events, use this command:
+<code bash>
+hs-mirror -i $SOURCE-o $OUTPUT_DIR -t evgen
+</code>
+Generally, you do not need to index files in the mirror directory.
+====== Summary ======
+When everything is done, this is what you should expect:
+  * You files will be visible on the main HepSim web page and on the current mirrors (takes ~ few days to propagate the changes)
+  * You can search your files etc. using the main HepSim web page
+  * You can search, list and download files using hs-toolkit commands (hs-find, hs-ls, hs-get etc)
+  * Since your files are public, there is good chance that somebody will make a mirror to reduce the load on your server
+  * You server will be listed on the page [[http://atlaswww.hep.anl.gov/hepsim/summary.php|statistics summary]]
  --- //[[[email protected]|Sergei Chekanov]] 2016/04/28 21:31//
+ --- //[[[email protected]|Sergei Chekanov]] 2016/10/24 21:31//