Skip to content

Commit

Permalink
Restructuring the configurational abstract
Browse files Browse the repository at this point in the history
  • Loading branch information
DhruvSondhi committed Jun 1, 2021
1 parent 00e1c4d commit 9086b0e
Showing 1 changed file with 19 additions and 12 deletions.
31 changes: 19 additions & 12 deletions docs/using/components/configuration/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,38 +50,45 @@ 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.

If one doesn't specify a ``file`` section, the code requires two sections (``velocities`` and ``densities``) and a
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.
Expand Down

0 comments on commit 9086b0e

Please sign in to comment.