Command Line API¶
pyhf¶
pyhf [OPTIONS] COMMAND [ARGS]...
Options
-
--version
¶
Show the version and exit.
cls¶
pyhf cls [OPTIONS] [WORKSPACE]
Options
-
--output-file
<output_file>
¶ The location of the output json file. If not specified, prints to screen.
-
--measurement
<measurement>
¶
-
-p
,
--patch
<patch>
¶
-
--testpoi
<testpoi>
¶
-
--teststat
<teststat>
¶ - Options
q|qtilde
-
--backend
<backend>
¶ The tensor backend used for the calculation.
- Options
numpy|pytorch|tensorflow|np|torch|tf
-
--optimizer
<optimizer>
¶
-
--optconf
<optconf>
¶
Arguments
-
WORKSPACE
¶
Optional argument
combine¶
Combine two workspaces into a single workspace.
See pyhf.workspace.Workspace.combine()
for more information.
pyhf combine [OPTIONS] [WORKSPACE_ONE] [WORKSPACE_TWO]
Options
-
--output-file
<output_file>
¶ The location of the output json file. If not specified, prints to screen.
Arguments
-
WORKSPACE_ONE
¶
Optional argument
-
WORKSPACE_TWO
¶
Optional argument
inspect¶
pyhf inspect [OPTIONS] [WORKSPACE]
Options
-
--output-file
<output_file>
¶ The location of the output json file. If not specified, prints to screen.
-
--measurement
<measurement>
¶
Arguments
-
WORKSPACE
¶
Optional argument
json2xml¶
pyhf json2xml [OPTIONS] [WORKSPACE]
Options
-
--output-dir
<output_dir>
¶
-
--specroot
<specroot>
¶
-
--dataroot
<dataroot>
¶
-
--resultprefix
<resultprefix>
¶
-
-p
,
--patch
<patch>
¶
Arguments
-
WORKSPACE
¶
Optional argument
prune¶
Prune components from the workspace.
See pyhf.workspace.Workspace.prune()
for more information.
pyhf prune [OPTIONS] [WORKSPACE]
Options
-
--output-file
<output_file>
¶ The location of the output json file. If not specified, prints to screen.
-
-c
,
--channel
<channel>
¶
-
-s
,
--sample
<sample>
¶
-
-m
,
--modifier
<modifier>
¶
-
-t
,
--modifier-type
<modifier_type>
¶ - Options
histosys|lumi|normfactor|normsys|shapefactor|shapesys|staterror
-
--measurement
<measurement>
¶
Arguments
-
WORKSPACE
¶
Optional argument
rename¶
Rename components of the workspace.
See pyhf.workspace.Workspace.rename()
for more information.
pyhf rename [OPTIONS] [WORKSPACE]
Options
-
--output-file
<output_file>
¶ The location of the output json file. If not specified, prints to screen.
-
-c
,
--channel
<channel>
¶
-
-s
,
--sample
<sample>
¶
-
-m
,
--modifier
<modifier>
¶
-
--measurement
<measurement>
¶
Arguments
-
WORKSPACE
¶
Optional argument
xml2json¶
Entrypoint XML: The top-level XML file for the PDF definition.
pyhf xml2json [OPTIONS] ENTRYPOINT_XML
Options
-
--basedir
<basedir>
¶ The base directory for the XML files to point relative to.
-
--output-file
<output_file>
¶ The location of the output json file. If not specified, prints to screen.
-
--track-progress
,
--hide-progress
¶
Arguments
-
ENTRYPOINT_XML
¶
Required argument