esbo_ds/ESBO-ETC
esbo_ds/ESBO-ETC
11
0
Fork 1
Code Issues 1 Pull Requests Releases 1 Wiki Activity

Information on attributes added

Browse Source
This commit is contained in:
Lukas Klass 2020-05-27 10:15:28 +02:00
parent 3fd5527f31
commit 943929678d
1 changed files with 23 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/source/configuration/configuration.rst
View File

@ -2,10 +2,27 @@
Building the Configuration Building the Configuration
************************** **************************
ESBO-ETC has to be configured by a XML-file. For basic information on XML and how to edit XML-files, have a look at ESBO-ETC has to be configured by a XML-file. For basic information on XML and how to edit XML-files, have a look at
`this tutorial <https://www.w3schools.com/xml/default.asp>`_. During the initialization of the program, `this tutorial <https://www.w3schools.com/xml/default.asp>`_.
the configuration is checked and possible errors reported with recommendations on how to fix the errors. Each parameter of the configuration is defined by a XML-tag which is indicated by
The given attributes are the minimal attributes. This means, that additional attributes like *comment* can be added
without breaking the configuration. This can be helpful to document tags as shown in the example below. .. code-block:: xml
<tag_name/>
A parameter can contain multiple attributes which are defined as key-value-pairs and some of them may be optional.
All attribute values must be quoted as in the example below. The required types shown in the documentation refer to the unquoted value.
Most numeric attributes require a unit which has to be defined as a second attribute with the suffix *_unit* which is also shown in the example below.
All astropy units defined `here <https://docs.astropy.org/en/stable/units/>`_ can be used.
.. code-block:: xml
<tag_name val="10" val_unit="s"/>
The tree structure of the configuration file is explained below.
During the initialization of the program, the configuration is checked and possible errors reported with recommendations on how to fix the errors.
The attributes in the documentation below are the minimal attributes. This means, that additional attributes like *comment* can be added
without breaking the configuration. This can be helpful to document tags as shown in the :ref:`example_config`.
Basic Structure Basic Structure
=============== ===============
@ -66,6 +83,8 @@ In case of structured text, the units of the columns have to be defined in the c
| ... | ... | | ... | ... |
+-----------------+------------------------------+ +-----------------+------------------------------+
.. _example_config:
Example Configuration Example Configuration
===================== =====================