Skip to content

Top-level components

In the following, the top-level components of HS\(^3\) and their parameters/arguments are described. Each component is completely optional, but certain components may depend on other components, which should be provided in that case. The only exception is the component metadata containing the version of HS\(^3\), which is always required. The supported top-level components are

  • distributions: (optional) array of objects defining distributions
  • functions: (optional) array of objects defining mathematical functions
  • data: (optional) array of objects defining observed or simulated data
  • likelihoods: (optional) array of objects defining combinations of distributions and data
  • domains: (optional) array of objects defining domains, describing ranges of parameters
  • parameter_points: (optional) array of objects defining parameter points. These may be used as starting points for minimizations or to document best-fit-values or nominal truth values of datasets
  • analyses: (optional) array of objects defining suggested analyses to be run on the models in this file
  • metadata: required struct containing meta information; HS\(^3\) version number (required), authors, paper references, package versions, data/analysis descriptions (optional)
  • misc: (optional) struct containing miscellaneous information, e.g. optimizer settings, plotting colors, etc.

In the following each of these are described in more detail with respect to their own structure.