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

Update docs for atmospheric ATRAN files

Browse Source
This commit is contained in:
Lukas Klass 2020-09-30 21:58:35 +02:00
parent 59c5cd8000
commit 59aa006c5e
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/source/configuration/optical_components.rst
View File

@ -17,11 +17,20 @@ This component models the behaviour of an atmosphere which has a spectral transm
<optical_component type="Atmosphere" transmittance="PathToTransmittanceFile" emission="PathToEmissionFile"/> <optical_component type="Atmosphere" transmittance="PathToTransmittanceFile" emission="PathToEmissionFile"/>
.. code-block:: xml
<optical_component type="Atmosphere" transmittance="PathToATRANFile" temp="200" temp_unit="K"/>
Attributes: Attributes:
* | **transmittance:** str * | **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* * | **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`. | 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 StrayLight
---------- ----------