Merge pull request #13 from lcorcodilos/doc_dev

Complete python documentation
lcorcodilos · Oct 20, 2020 · 2ca6b97 · 2ca6b97
2 parents e5893d6 + e792131
commit 2ca6b97
Show file tree

Hide file tree

Showing 195 changed files with 6,745 additions and 1,975 deletions.
diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@ TIMBER (Tree Interface for Making Binned Events with RDataFrame) is an easy-to-u
 Default arguments assume the use of the NanoAOD format but any ROOT TTree can be processed.
 
 ## Quick install
-Python 3 is recommended since 2.7 is now no longer supported. Remember to make sure your 
+Python 3 is recommended since Python 2.7 reached end-of-life on January 1st, 2020. Remember to make sure your 
 ROOT version has been built with Python 3 compatibility. For information on how to do this, see
 [this explanation](doxysetup/Python3.md).
 Working in a virtual environment is also recommended. Below are the commands for using virtualenv but

diff --git a/TIMBER/Analyzer.py b/TIMBER/Analyzer.py
diff --git a/TIMBER/Framework/Corrections/JetCorrections/AK4corrections.cc b/TIMBER/Framework/Corrections/JetCorrections/AK4corrections.cc
diff --git a/TIMBER/Framework/Corrections/JetCorrections/AK8corrections.cc b/TIMBER/Framework/Corrections/JetCorrections/AK8corrections.cc
diff --git a/TIMBER/Framework/Corrections/JetCorrections/JetRecalibrator.cc b/TIMBER/Framework/Corrections/JetCorrections/JetRecalibrator.cc
diff --git a/TIMBER/Framework/Corrections/JetCorrections/JetSmearer.cc b/TIMBER/Framework/Corrections/JetCorrections/JetSmearer.cc
diff --git a/TIMBER/Framework/Corrections/in_progress/pileup.cc b/TIMBER/Framework/Corrections/in_progress/pileup.cc
diff --git a/TIMBER/Framework/Corrections/in_progress/tagging.cc b/TIMBER/Framework/Corrections/in_progress/tagging.cc
diff --git a/TIMBER/Framework/README.md b/TIMBER/Framework/README.md
@@ -5,7 +5,7 @@ Home to generic C++ modules.
 # Developer Notes
 
 Adding C++ modules for use in TIMBER is relatively simple but the code makes several
-assumptions about the structure of the module if you'd like to use it as a #Correction.
+assumptions about the structure of the module if you'd like to use it as a @ref TIMBER.Analyzer.Correction.
 
 A correction module should be built as a class so that the initializer can be used to book
 objects like files, histograms, etc that we want to load before looping over the RDataFrame.

diff --git a/TIMBER/Framework/Corrections/TopPt_weight.cc → .../Framework/in_development/TopPt_weight.cc b/TIMBER/Framework/Corrections/TopPt_weight.cc → .../Framework/in_development/TopPt_weight.cc
diff --git a/...R/Framework/Corrections/Trigger_weight.cc → ...ramework/in_development/Trigger_weight.cc b/...R/Framework/Corrections/Trigger_weight.cc → ...ramework/in_development/Trigger_weight.cc