From 59aa006c5e930dbd8789b3fd0a9284a1e4ba005f Mon Sep 17 00:00:00 2001 From: LukasK13 Date: Wed, 30 Sep 2020 21:58:35 +0200 Subject: [PATCH] Update docs for atmospheric ATRAN files --- docs/source/configuration/optical_components.rst | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/source/configuration/optical_components.rst b/docs/source/configuration/optical_components.rst index 66790e4..fa0f7b2 100644 --- a/docs/source/configuration/optical_components.rst +++ b/docs/source/configuration/optical_components.rst @@ -17,11 +17,20 @@ This component models the behaviour of an atmosphere which has a spectral transm +.. code-block:: xml + + + + Attributes: * | **transmittance:** str - | The path to the file containing the spectral transmittance coefficients. For details on the required file structure see also :ref:`reading_csv`. + | The path to the file containing the spectral transmittance coefficients. For details on the required file structure see also :ref:`reading_csv`. If the output of ATRAN is given, the emission parameter is not available. Instead the parameter temp is used for the atmospheric emission. * | **emission:** str, *optional* | The path to the file containing the spectral radiance of the emission. For details on the required file structure see also :ref:`reading_csv`. + * | **temp:** str, *optional* + | The atmospheric temperature used for black body emission using the complement of the ATRAN tranmittance. + * | **temp_unit:** str, *optional* = "K" + | Unit of the atmospheric temperature used for black body emission using the complement of the ATRAN tranmittance. StrayLight ----------