Verified Commit f94c5c79 authored by Frank Sauerburger's avatar Frank Sauerburger
Browse files

Add TRExFitter interface to docs

parent e8e66960
Pipeline #3384234 failed with stages
in 1 minute and 14 seconds
......@@ -10,7 +10,6 @@
Introduction <self>
why
GettingStarted.ipynb
Settings
interfaces
CommandLineTool
......
......@@ -101,3 +101,16 @@ Embed plots with:
\includeuhepp{1.0}{a378d2b0-cde2-4266-be9b-85945d94880d}
TRExFitter
----------
The ATLAS software `TRExFitter <https://trexfitter-docs.web.cern.ch/trexfitter-docs/>`_
provides the configuration option `UheppFormat` which,
if set to `TRUE`, will trigger the generation of pre- and post-fit plots in signal,
control and validation regions in uhepp format. The output is a YAML file which can be
managed by the Python package `uhepp` or the command-line tool `uhepp`. A common
use pattern is to push generated files to `uhepp.org <https://uhepp.org/>`_.
Consult the `TRExFitter documentation
<https://trexfitter-docs.web.cern.ch/trexfitter-docs/interfacing_tools/uhepp/>`_ for further information.
Sphinx
sphinx_rtd_theme
nbsphinx
Sphinx~=4.20
sphinx_rtd_theme~=1.0.0
nbsphinx~=0.8.2
......@@ -2597,7 +2597,7 @@ class UHeppHist(UHepPlotModel):
fig.show()
def pull(uuid, api_url=None, api_key=None, full_link=None):
"""Retrieve a :class:`UHepPlot` from a central server"""
"""Retrieve a :class:`UHeppPlot` from a central server"""
if api_key is None:
api_key = os.environ.get("UHEPP_TOKEN", None)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment