diff --git a/docs/source/configuration/configuration.rst b/docs/source/configuration/configuration.rst index f00d2d6..7c87d8a 100644 --- a/docs/source/configuration/configuration.rst +++ b/docs/source/configuration/configuration.rst @@ -1,18 +1,125 @@ ************************** 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 +`this tutorial `_. During the initialization of the program, +the configuration is checked and possible errors reported with recommendations on how to fix the errors. +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. Basic Structure -============================ +=============== +The basic structure of the configuration file is shown in the following tree. The configuration structure starts with a +root element which is divided into common paramaters, astroscene, common_optics and instrument. This basic structure has +to be used and must not be changed. -Common conf -============================ +:: + + root + ├── common + │ └── Common configuration parameters + ├── astroscene + │ └── Components outside of the telescope like target, atmosphere, ... + ├── common_optics + │ └── Common components for all sensors like mirrors, lenses, ... + └── instrument + └── The sensor and its configuration parameters + +Common +====== + +.. include:: common.rst + +.. _target: Target -============================ +====== + +.. include:: target.rst Optical components -============================ +================== + +.. include:: optical_components.rst Sensor -============================ +====== + +.. include:: sensor.rst + +.. _reading_csv: + +Reading CSV-Files +================= + +The format of a file has to be either structured text (e.g. CSV) or astropy ECSV. The format of the file will be automatically detected during read. +In case of structured text, the units of the columns have to be defined in the column header within square brackets +(e.g. "wavelength [nm]"). The file must contain two columns with units: wavelength and the spectral quantity: + ++-----------------+------------------------------+ +| wavelength [nm] | emission [W/(nm\*m^2\*sr)] | ++=================+==============================+ +| 200 | 1.345e-15 | ++-----------------+------------------------------+ +| 201 | 1.364e-15 | ++-----------------+------------------------------+ +| ... | ... | ++-----------------+------------------------------+ + +Example Configuration +===================== + +.. code-block:: xml + :linenos: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +