EasyScan_HEP

About

EasyScan_HEP is an easy-to-use tool providing a comfortable way connecting programs to scan the parameter space for high energy physics models.

It includes four scan methods(random, grid, MCMC, MultiNest), some popular data analysis algorithm (Bayes analysis, CLs) and a well defined framework to connect to high energy physics programs. With only few necessary input parameters(one page), users can easily get visible results with different scan methods.

Download

Version beta.1.0.0 (12.07.2016) is available here: Download

Install

EasyScan_HEP requires Python 2.x with modules scipy, numpy, matplotlib, progressbar on your system. Most systems already come with a Python installation, which you can easily check by typing

$ python -V

and install the modules (on Ubuntu) by typing

$ sudo apt-get install python-{scipy,numpy,matplotlib,progressbar}

To use MultiNest methodology, you need to install the PyMultiNest and MultiNest libraries(see PyMultiNest installation for detailed install instructions) on your system.

Test run

1. ‘Test run’ to make sure program EasyScan_HEP installation sucessfully. Going into the directory <EasyScanHEP>/bin ( Assuming <EasyScanHEP> stands for the installation directory of program ‘EasyScan_HEP’ ) and Running EasyScan_HEP

$ cd <EasyScanHEP>/bin
$ ./easyScan.py test.ini

initial file test.ini for EasyScan_HEP and its content

test.ini
[scan]
Result file name:  test
Scan method:       MCMC
Points number:     1000
#                  ID     Prior  Min    MAX
Input parametes:   x,     Flat,  -2,    2
                   y,     Flat,  -2,    2.5

[program0]
Program name:    zytest
Execute command: ./test.py
Command path:    ../Externals/zytest/
Input file:      1, ../Externals/zytest/inp.dat
#                varID   fileID  method    other
Input variable:  x,      1,      Position, 1,  1
                 y,      1,      Position, 1,  2
Output file:     1, ../Externals/zytest/output.txt
#                varID   fileID  method    other
Output variable: z,      1,      Position, 1 , 1

[constraint]
#                      mean    sigma
Gaussian:        z,    1.0,    1.0

[plot]
color: x, y, z
  • Successfully running our program with figure <EasyScanHEP>/bin/test/Figures/fig_x_y_z.png as following
_images/test_run.png
  • test.ini providing the initial information for running EasyScan_HEP. It scanning parameters x and y by random scattering in range (0, 3.14) and (-3.14, 3.14) both with flat distribution function.
  • ‘Execute command: ./test.py’ corresponding to <EasyScanHEP>/externals/zytest/test.py, which gave value of ‘z’ in the temporary file <EasyScanHEP>/Externals/zytest/output.txt.

Also as a simplest input sample, it can be extended to accomplish more functions, such as using other scan method, adding more than one programs, and generating more figures. To get more instructions refering our manual document below.

Getting help

If you meet any problem with EasyScan_HEP, please contact with Yang Zhang or Liang Shang.

Cite

Please cite corresponding program according to the algorithm you using in this package.

If EasyScan_HEP enables your research, please consider citing our publication: ITP New Physics Legion, 2016, CAS (BibTex) In this paper, we introduce the software package officially, and compare the parameter space of CMSSM and CNMSSM with different scan and analysis methodologies.

Indices and tables