19.1. Introduction to PyROOT
Table of Contents
Using ROOT from Python
PyROOT is the Python interface to ROOT. It lets you use almost all ROOT features directly from Python code, so you can combine ROOT’s data analysis, histograms, and TTrees with the flexibility of the Python ecosystem.
At a conceptual level, PyROOT is not a separate program. It is a set of Python bindings that expose ROOT’s C++ classes as Python objects. A TH1F histogram in PyROOT is the same C++ class that you use in C++, only controlled from Python. You can create ROOT objects, call their methods, and pass them around in Python just like any other Python object.
PyROOT is especially useful when you want to:
Work interactively in a Jupyter notebook while still using ROOT’s powerful I/O and plotting.
Glue ROOT analysis with Python libraries such as NumPy, SciPy, or pandas.
Prototype analysis quickly in Python, then later move performance-critical parts to compiled C++ if needed.
You will use the same ROOT class names and methods that appear elsewhere in this course. The main difference is the syntax: you write Python instead of C++. For example, in Python you write
import ROOT
h = ROOT.TH1F("h", "Example", 100, 0.0, 10.0)
h.Fill(3.14)
h.Draw()which corresponds very closely to the equivalent C++ code, but uses Python indentation, no semicolons, and Python’s import system.
The PyROOT module is usually imported under the name ROOT. Once imported, every ROOT class is accessed as an attribute of that module. The table below shows basic correspondences between concepts in C++ ROOT and PyROOT.
| Concept | C++ ROOT example | PyROOT example |
|---|---|---|
| Include ROOT headers | #include "TH1F.h" | import ROOT |
| Create a histogram | TH1F *h = new TH1F("h","t",100,0,1); | h = ROOT.TH1F("h", "t", 100, 0, 1) |
| Call a method | h->Fill(0.5); | h.Fill(0.5) |
| Draw on canvas | h->Draw(); | h.Draw() |
| Access ROOT constants | kRed | ROOT.kRed |
In PyROOT you still use C++ class names and method names. Only the language syntax around them is Pythonic. There is no separate "Python version" of ROOT classes.
Another important aspect is that PyROOT talks directly to the C++ libraries that are installed with ROOT. This means that if a C++ class exists in your ROOT installation, you can generally access it immediately from Python without extra wrappers.
Because PyROOT is just another way to drive ROOT, you should think of it as an alternative frontend parallel to the C++ macro and compiled approaches that you learned earlier. The analysis concepts, the ROOT object model, and the file format all stay the same. Only the environment and language you use to control ROOT change.
Starting PyROOT
To start using ROOT from Python, your system must have both Python and ROOT installed, with PyROOT enabled. Many binary ROOT distributions already include PyROOT. If you installed ROOT using a package manager or Conda, PyROOT is usually available automatically once you activate the appropriate environment and set up ROOT.
The most common way to start PyROOT is to use the standard Python interpreter and import the ROOT module. After your shell environment is configured for ROOT, you can run in a terminal:
pythonor
python3Then inside the Python prompt, import ROOT:
import ROOTIf this import runs without errors, PyROOT is available. You can make a quick functional check by creating and drawing a simple histogram:
import ROOT
h = ROOT.TH1F("h", "Test histogram", 50, 0.0, 5.0)
for i in range(1000):
h.Fill(ROOT.gRandom.Gaus(2.5, 0.5))
c = ROOT.TCanvas("c", "Canvas", 800, 600)
h.Draw()
c.Update()This code should open a ROOT graphics window with a histogram. When running from a terminal, the script might return control to the shell immediately and close the window. To keep the window open, you can add:
input("Press Enter to exit")or, when running from IPython or a Jupyter notebook, ROOT will normally integrate with the event loop and keep the canvas visible while the kernel is running.
You can also start PyROOT from the command line by running a Python script that uses ROOT. Save a file, for example example.py, with:
import ROOT
print("ROOT version:", ROOT.gROOT.GetVersion())Then run:
python example.pyThis prints the ROOT version and confirms that Python can load the ROOT libraries.
If the command python refers to a different Python installation than the one where PyROOT is visible, importing ROOT may fail. In that situation, ensure that you are using the Python binary that belongs to your ROOT or Conda environment. For Conda installations, for example, you would typically do:
conda activate myrootenv
python
and then import ROOT inside that environment.
Another popular way to start PyROOT is inside a Jupyter notebook. After configuring your environment, you can launch
jupyter notebookcreate a new Python notebook, and in the first cell write:
import ROOT
ROOT.gROOT.SetBatch(False) # allow interactive graphics if neededFrom there you can work interactively with ROOT objects, inspect them inline, and combine plots and analysis steps with narrative text and equations.
To use PyROOT successfully, you must start Python from an environment where ROOT is set up. This typically means sourcing ROOT’s thisroot.sh script or activating the Conda environment that provided ROOT, before launching Python or Jupyter.
Once PyROOT is imported, the rest of this ROOT and Python section will show how to create and manipulate histograms, graphs, and TTrees from Python, and how to connect them to common Python tools.
Views: 0
Where to Move
Move chapter:
- ☰ 1. Introduction to ROOT
- ☰ 1.1. What Is ROOT?
- ☰ 1.2. Installing ROOT
- ☰ 1.3. Starting ROOT
- ☰ 1.4. Your First ROOT Session
-
- ☰ 2. C++ Basics for ROOT
- ☰ 2.1. Why ROOT Uses C++
- ☰ 2.2. Variables and Data Types
- ☰ 2.3. Operators
- ☰ 2.4. Conditional Statements
- ☰ 2.5. Loops
- ☰ 2.6. Functions
- ☰ 2.7. Arrays and Vectors
-
- ☰ 3. ROOT Macros
- ☰ 3.1. What Is a ROOT Macro?
- ☰ 3.2. Running ROOT Macros
- ☰ 3.3. Functions Inside ROOT Macros
- ☰ 3.4. Compiling ROOT Macros
- ☰ 3.5. Organizing a ROOT Project
-
- ☰ 4. ROOT Objects and the ROOT Object Model
- ☰ 4.1. Introduction to ROOT Classes
- ☰ 4.2. Object Names and Titles
- ☰ 4.3. ROOT Collections
- ☰ 4.4. Inspecting ROOT Objects
-
- ☰ 5. Histograms
- ☰ 5.1. Introduction to Histograms
- ☰ 5.2. Creating a 1D Histogram
- ☰ 5.3. Filling Histograms
- ☰ 5.4. Drawing Histograms
- ☰ 5.5. Histogram Properties
- ☰ 5.6. Accessing Histogram Bins
- ☰ 5.7. Histogram Errors
- ☰ 5.8. Normalizing Histograms
- ☰ 5.9. Combining Histograms
-
- ☰ 6. Two-Dimensional Histograms
- ☰ 6.1. Creating 2D Histograms
- ☰ 6.2. Filling 2D Histograms
- ☰ 6.3. Drawing 2D Histograms
- ☰ 6.4. Projections
- ☰ 6.5. Profiles
-
- ☰ 7. Graphs
- ☰ 7.1. Introduction to TGraph
- ☰ 7.2. Creating a TGraph
- ☰ 7.3. Graph Styling
- ☰ 7.4. TGraphErrors
- ☰ 7.5. TGraphAsymmErrors
- ☰ 7.6. MultiGraph
-
- ☰ 8. Canvases and Plotting
- ☰ 8.1. TCanvas
- ☰ 8.2. Dividing a Canvas
- ☰ 8.3. Drawing Multiple Objects
- ☰ 8.4. Legends
- ☰ 8.5. Text and Annotations
- ☰ 8.6. Logarithmic Axes
- ☰ 8.7. Saving Plots
-
- ☰ 9. Styling ROOT Plots
- ☰ 9.1. ROOT Plot Styles
- ☰ 9.2. Axis Configuration
- ☰ 9.3. Line Styles
- ☰ 9.4. Marker Styles
- ☰ 9.5. Publication-Quality Figures
-
- ☰ 10. Mathematical Functions
- ☰ 10.1. Introduction to TF1
- ☰ 10.2. Built-in Functions
- ☰ 10.3. Custom Functions
- ☰ 10.4. Evaluating Functions
- ☰ 10.5. Function Integrals
-
- ☰ 11. Curve Fitting
- ☰ 11.1. Introduction to Fitting
- ☰ 11.2. Gaussian Fits
- ☰ 11.3. Polynomial Fits
- ☰ 11.4. Custom Fit Functions
- ☰ 11.5. Fit Parameters
- ☰ 11.6. Goodness of Fit
- ☰ 11.7. Fit Residuals
- ☰ 11.8. Fitting Graphs
-
- ☰ 12. ROOT Files
- ☰ 12.1. Introduction to ROOT Files
- ☰ 12.2. Creating ROOT Files
- ☰ 12.3. Writing Objects
- ☰ 12.4. Reading ROOT Files
- ☰ 12.5. Exploring ROOT Files
- ☰ 12.6. Directories Inside ROOT Files
-
- ☰ 13. TTrees
- ☰ 13.1. Introduction to TTrees
- ☰ 13.2. Creating a TTree
- ☰ 13.3. Filling a TTree
- ☰ 13.4. Writing a TTree to a File
- ☰ 13.5. Reading a TTree
- ☰ 13.6. Inspecting TTrees
- ☰ 13.7. Drawing Data from TTrees
- ☰ 13.8. Applying Selection Cuts
- ☰ 13.9. Branch Addresses
-
- ☰ 14. Event-Based Data Analysis
- ☰ 14.1. Understanding Event Data
- ☰ 14.2. Event Loops
- ☰ 14.3. Event Selection
- ☰ 14.4. Derived Quantities
- ☰ 14.5. Analysis Workflow
-
- ☰ 15. Working with Real Experimental Data
- ☰ 15.1. Importing Text Data
- ☰ 15.2. Converting Data to ROOT
- ☰ 15.3. Data Cleaning
- ☰ 15.4. Data Calibration
- ☰ 15.5. Signal and Background
-
- ☰ 16. Random Numbers and Simulations
- ☰ 16.1. Random Number Generation
- ☰ 16.2. Common Distributions
- ☰ 16.3. Simple Monte Carlo Simulation
- ☰ 16.4. Detector Resolution Simulation
- ☰ 16.5. Efficiency Simulation
-
- ☰ 17. Statistical Analysis with ROOT
- ☰ 17.1. Basic Statistics
- ☰ 17.2. Probability Distributions
- ☰ 17.3. Statistical Uncertainties
- ☰ 17.4. Chi-Square Tests
- ☰ 17.5. Confidence Intervals
-
- ☰ 18. Modern ROOT with RDataFrame
- ☰ 18.1. Introduction to RDataFrame
- ☰ 18.2. Loading Data
- ☰ 18.3. Filtering Data
- ☰ 18.4. Defining New Columns
- ☰ 18.5. Creating Histograms
- ☰ 18.6. Statistical Operations
- ☰ 18.7. Saving Results
- ☰ 18.8. Multithreading
-
- ☰ 19. ROOT and Python
- ☰ 19.1. Introduction to PyROOT
- ☰ 19.2. ROOT Objects in Python
- ☰ 19.3. Reading ROOT Files with Python
- ☰ 19.4. PyROOT and NumPy
- ☰ 19.5. PyROOT and Matplotlib
- ☰ 19.6. Choosing Between C++ and Python
-
- ☰ 20. Advanced TTree Techniques
- ☰ 20.1. Trees with Multiple Branches
- ☰ 20.2. Storing std::vector Objects
- ☰ 20.3. TChain
- ☰ 20.4. Friends
- ☰ 20.5. Efficient TTree Analysis
-
- ☰ 21. ROOT for Particle and Nuclear Physics
- ☰ 21.1. Four-Vectors
- ☰ 21.2. Particle Kinematics
- ☰ 21.3. Invariant Mass
- ☰ 21.4. Angular Distributions
- ☰ 21.5. Detector Spectra
-
- ☰ 22. Debugging and Common ROOT Problems
- ☰ 22.1. ROOT Object Ownership
- ☰ 22.2. Null Pointers
- ☰ 22.3. Segmentation Faults
- ☰ 22.4. Missing Histograms
- ☰ 22.5. ROOT File Problems
- ☰ 22.6. TTree Branch Problems
- ☰ 22.7. Histogram Range Problems
- ☰ 22.8. Fit Failures
- ☰ 22.9. Debugging ROOT Macros
-
- ☰ 23. Writing Better ROOT Analysis Code
- ☰ 23.1. Separating Analysis and Plotting
- ☰ 23.2. Using Functions
- ☰ 23.3. Using Header Files
- ☰ 23.4. Naming Conventions
- ☰ 23.5. Avoiding Hard-Coded Values
- ☰ 23.6. Configuration Parameters
- ☰ 23.7. Reproducible Analysis
- ☰ 23.8. Version Control with Git
-
- ☰ 24. Final Project
- ☰ 24.1. Project Overview
- ☰ 24.2. Analyze a complete scientific dataset using ROOT.
- ☰ 24.3. Import the Data
- ☰ 24.4. Explore the Dataset
- ☰ 24.5. Apply Data Selection
- ☰ 24.6. Create Histograms
- ☰ 24.7. Fit the Data
- ☰ 24.8. Calculate Physical Quantities
- ☰ 24.9. Estimate Statistical Uncertainties
- ☰ 24.10. Create Publication-Quality Figures
- ☰ 24.11. Save the Analysis Results
- ☰ 24.12. Write a Short Analysis Report
-
- ☰ 25. Appendices
- ☰ 25.1. A. ROOT Command Cheat Sheet
- ☰ 25.2. B. ROOT Histogram Classes
- ☰ 25.3. C. ROOT Graph Classes
- ☰ 25.4. D. Common TTree Commands
- ☰ 25.5. E. Common Drawing Options
- ☰ 25.6. F. Common Fit Functions
- ☰ 25.7. G. ROOT C++ Cheat Sheet
- ☰ 25.8. H. PyROOT Cheat Sheet
- ☰ 25.9. I. Common ROOT Errors and Solutions
- ☰ 25.10. J. Recommended ROOT Analysis Workflow
-
Comments
Please login to add a comment.
Don't have an account? Register now!