Skip to content

Latest commit

 

History

History
43 lines (27 loc) · 1.85 KB

config.rst

File metadata and controls

43 lines (27 loc) · 1.85 KB

Configuration schema

The configuration schema for cabinetry is given below. It is defined via a json schema that can be found at src/cabinetry/schemas/config.json.

The General block holds general settings, followed by blocks that take lists of objects: regions, samples, normalization factors, and systematics. The Regions, Samples and NormFactors blocks are required, while Systematics is optional. Settings shown in bold are required.

.. jsonschema:: ../src/cabinetry/schemas/config.json#/properties/General
.. jsonschema:: ../src/cabinetry/schemas/config.json#/properties/Regions
.. jsonschema:: ../src/cabinetry/schemas/config.json#/properties/Samples
.. jsonschema:: ../src/cabinetry/schemas/config.json#/properties/NormFactors
.. jsonschema:: ../src/cabinetry/schemas/config.json#/properties/Systematics

Details about the setting blocks:

.. jsonschema:: ../src/cabinetry/schemas/config.json#/definitions/general

.. jsonschema:: ../src/cabinetry/schemas/config.json#/definitions/region

.. jsonschema:: ../src/cabinetry/schemas/config.json#/definitions/sample

.. jsonschema:: ../src/cabinetry/schemas/config.json#/definitions/normfactor

.. jsonschema:: ../src/cabinetry/schemas/config.json#/definitions/systematic

Common options:

.. jsonschema:: ../src/cabinetry/schemas/config.json#/definitions/template_setting

.. jsonschema:: ../src/cabinetry/schemas/config.json#/definitions/samples_setting

.. jsonschema:: ../src/cabinetry/schemas/config.json#/definitions/samplepath_setting

.. jsonschema:: ../src/cabinetry/schemas/config.json#/definitions/regions_setting

.. jsonschema:: ../src/cabinetry/schemas/config.json#/definitions/smoothing_setting