From eb400f021a3c9d5d39f2fbf66ed1cf1714442146 Mon Sep 17 00:00:00 2001 From: rskuza Date: Wed, 24 Aug 2022 12:05:31 +0200 Subject: [PATCH] README File added --- Code/Scripts/Python Scripts/README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 Code/Scripts/Python Scripts/README.md diff --git a/Code/Scripts/Python Scripts/README.md b/Code/Scripts/Python Scripts/README.md new file mode 100644 index 0000000..2aab4ac --- /dev/null +++ b/Code/Scripts/Python Scripts/README.md @@ -0,0 +1,18 @@ +# Angular Analysis of B+toK*+Pi0Mu-Mu+ +## Setup +In order to setup a python virtual environment with the corresponding dependencies, do the following: +1. `pip install virtualenv` +2. `virtualenv myenv` +3. `source myenv/bin/activate` +4. `pip install -r requirements.txt` + +Afterwards you can use your virtual python environment in order to run the code. But before you do, you need to setup the properties.env. Inside of properties.env you will find different configuration variables which are used throughout the code in order to control the behavior of the code. Below you can find a table which summarizes what these environment variables do. +|Environment Variable|Use-Case| +| -------------------- | -------- | +|LOWER_COSTHETAK_CUT |Controls the lower boundary of cos(theta_K)| +|UPPER_COSTHETAK_CUT |Controls the upper boundary of cos(theta_K)| +|SYS_PATH|We need one local package in order to make the code work, namely hep_analytics which you can also find in this repo, the interpreter needs to find that package, so set SYS_PATH to the relative path to hep_analytics| +|GEN_FILE|Path to the Generator File| +|MC_FILE|Path to the MC File| +|MC_PHSP_FILE|Path to the PHSP MC File| +You are done!