README.org 2.08 KB
Newer Older
Simon Brass's avatar
Simon Brass committed
1 2
#+AUTHOR: Simon Braß
#+E-MAIL: brass@physik.uni-siegen.de
Simon Brass's avatar
Simon Brass committed
3

Simon Brass's avatar
Simon Brass committed
4
* WHIZARD Scripts
Simon Brass's avatar
Simon Brass committed
5

Simon Brass's avatar
Simon Brass committed
6 7 8 9 10
  An example run scripts can be found under [[file:run.sh]].
  The script can be copied to any directory and adjusted to the needs.
  To call the different functions of WHIZARD Scripts, type
  #+BEGIN_SRC
  ./run.sh <command> <process>
Simon Brass's avatar
Simon Brass committed
11
  #+END_SRC
Simon Brass's avatar
Simon Brass committed
12 13 14 15 16 17
  where process is the actual name of process inside the SINDARIN (and in
  general the nomenclature). The command can be any of the following:

** sindarin
   Must be called before anything else. The command sets up the directory
   structure set in <process>-config.yml and generate the SINDARIN files.
Simon Brass's avatar
Simon Brass committed
18 19 20
** debug
   Runs WHIZARD process and applies libtool to the executable such that the
   symbols and source code can be found by gdb.
Simon Brass's avatar
Simon Brass committed
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
** run
   Runs WHIZARD process and times, if =RUN_TIME=True=, and uses MPI, if =MPIRUN=True=.
** analyze
   Runs a Rivet analysis and runs =rivet-mkhtml=. The analysis can be set by =ANALYSIS=<NAME>=.
** compare
   Expect two directories: vamp and vamp2, and the corresponding SINDARIN files.

* init-sindarin.py
  The python script [[file:init-sindarin.py]] sets up the directory and generates the SINDARIN files as defined by the given config.yml.
  The overall structure of the yaml file is:
  #+BEGIN_SRC yml
---
# Process Id (will be extracted from SINDARIN filename
ppWj:
  # Defaults for all processes can be defined here
  - default:
      seed: 12345
      results: true
      iterations: 5:10000:"gw",5:20000
      integrate: True
      simulate: True
      n_events: 20000
  # Several processes allowd
  - process:
      name: ppWj
      rng_method: rng_stream
      integration_method: vamp2
      directory: vamp2
  - process:
      name: ppWj
      rng_method: tao
      integration_method: vamp
      directory: vamp
  #+END_SRC
  You can process-independent configuration in the default section.
Simon Brass's avatar
Simon Brass committed
56 57 58 59

* SLURM

** Short
Simon Brass's avatar
Simon Brass committed
60 61 62 63

   Two wrapper scripts, which creates the actual run script for =sbatch= and runs
   it. The /run-128.sh/ script is just for preparing a =MPI= run. The
   /run-mpi-128.sh/ is the actual run scripts and starts a job with 128 process.