Browse Source

Enhanced README

master
rskuza 2 years ago
parent
commit
3905f6bb57
  1. 7
      Code/Scripts/Python Scripts/README.md

7
Code/Scripts/Python Scripts/README.md

@ -17,7 +17,10 @@ Afterwards you can use your conda environment in order to run the code. But befo
|MC_PHSP_FILE|Path to the PHSP MC File|
If you want to see how to set the environment variables, have a look at `properties.env`. Also, I have run the code on the LHCbA1 machine but it should make no difference where you run the code.
You are done!
You are done (apply also the custom fixes described down below)!
## Custom Fix
The b2kstll package has a few caveats when you want to apply a cos(theta_K) cut since the normalisation will be wrong in this case for the pdfs. So in order to compensate for that, I changed a few lines in the packages code, have a look at the `b2kstll/models` folder, there you will find all the files which I touched.
## Useful Scripts
### root_file_inspect.py
@ -34,4 +37,4 @@ There are 3 scripts which are prefixed with `diff_pair_tables` and which are ver
The module `aggregate.py` exposes the `PathAggregator` which is very simple and simply builds a path string. For only this reason the class is not very useful but when your directory path setup is more complex and you do not want to manually type out all relevant paths, this class can be easily extended and adapted.
### package: processing
Exposes three modules: `extract`, `transform`, `visualisation`. `extract` exposes the `FileManager` which can be used to extract the relevant features out of the branches of a `root` file. `transform` exposes useful functions like `select_feature` in order to make cuts and `reweight_feature`. Take note that `select_feature` is not the most efficient way of doing cuts, for more efficient usage use the functionality of `uproot3` directly. `visualisation` exposes `reweight_comparing_plot` in order to plot 3 diagrams, two original features and the reweighted feature.
Exposes three modules: `extract`, `transform`, `visualisation`. `extract` exposes the `FileManager` which can be used to extract the relevant features out of the branches of a `root` file. `transform` exposes useful functions like `select_feature` in order to make cuts and `reweight_feature`. Take note that `select_feature` is not the most efficient way of doing cuts, for more efficient usage use the functionality of `uproot3` directly. `visualisation` exposes `reweight_comparing_plot` in order to plot 3 diagrams, two original features and the reweighted feature.
Loading…
Cancel
Save