diff --git a/docs/using/components/configuration/configuration.rst b/docs/using/components/configuration/configuration.rst index fbc62617652..34a1ccc50c6 100644 --- a/docs/using/components/configuration/configuration.rst +++ b/docs/using/components/configuration/configuration.rst @@ -50,18 +50,15 @@ file type where the information is stored or a number of other sections. .. jsonschema:: schemas/model.yml -.. jsonschema:: schemas/model_definitions.yml#/definitions/abundances/file - -.. jsonschema:: schemas/model_definitions.yml#/definitions/abundances/uniform - +Abundances +^^^^^^^^^^ The ``abundance`` section has a possible ``file`` parameter with ``type`` (currently only ``artis`` is allowed) and a ``name`` parameter giving a path to a file containing the abundance information. -.. jsonschema:: schemas/model_definitions.yml#/definitions/structure/file +.. jsonschema:: schemas/model_definitions.yml#/definitions/abundances/file -.. jsonschema:: schemas/model_definitions.yml#/definitions/structure/specific +.. jsonschema:: schemas/model_definitions.yml#/definitions/abundances/uniform -All types of ``structure`` definitions have two keywords in common: ``v_inner_boundary`` and ``v_outer_boundary``. In the ``structure`` section, one can specify a ``file`` section containing a ``type`` parameter (currently only ``artis`` is supported``) and a ``name`` parameter giving a path top a file. @@ -69,19 +66,29 @@ If one doesn't specify a ``file`` section, the code requires two sections (``vel parameter ``no_of_shells``. ``no_of_shells`` is the requested number of shells for a model. The ``velocity`` section requires a ``type``. Currently, only ``linear`` is supported. -.. jsonschema:: schemas/model_definitions.yml#/definitions/density/branch85_w7 - -.. jsonschema:: schemas/model_definitions.yml#/definitions/density/exponential +Structure +^^^^^^^^^ +All types of ``structure`` definitions have two keywords in common: ``v_inner_boundary`` and ``v_outer_boundary``. -.. jsonschema:: schemas/model_definitions.yml#/definitions/density/power_law +.. jsonschema:: schemas/model_definitions.yml#/definitions/structure/file -.. jsonschema:: schemas/model_definitions.yml#/definitions/density/uniform +.. jsonschema:: schemas/model_definitions.yml#/definitions/structure/specific +Densities +""""""""" In the ``densities`` section the ``type`` parameter again decides on the parameters. The type ``uniform`` only needs a ``value`` parameter with a density compatible quantity. The type ``branch85_w7`` uses a seven-order polynomial fit to the W7 model and is parametrised by time since explosion. The parameters ``time_0`` and ``density_coefficient`` are set to sensible defaults and should not be changed. +.. jsonschema:: schemas/model_definitions.yml#/definitions/density/branch85_w7 + +.. jsonschema:: schemas/model_definitions.yml#/definitions/density/exponential + +.. jsonschema:: schemas/model_definitions.yml#/definitions/density/power_law + +.. jsonschema:: schemas/model_definitions.yml#/definitions/density/uniform + .. warning:: In contrast to the ``structure`` section, the ``abundance`` section will not ignore abundances set in the rest of the section but merely will overwrite the abundances given in the file section.