Update README.md

This commit is contained in:
Joost van den Born committed 2020-05-27 15:49:42 +02:00
1 parent 79d30b7506
commit 16fc562304
1 file changed
+5 -6
+5 -6
View File
@@ -10,13 +10,12 @@ Author info: *Joost van den Born*, *born@astron.nl*
*Below you can find a set of models describing the atmospheric refraction and dispersion.* *Below you can find a set of models describing the atmospheric refraction and dispersion.*
**Contents:** **Contents:**
- atmosphericModel : Python model that can be used to calculate the atmospheric refraction and dispersion, the main content of this repository. - AstroAtmosphere : Python package that can be used to calculate the atmospheric refraction and dispersion, the main content of this repository.
- refractionModel.py : Python script that compares the output of the different refraction models.
Can be used as an example on how to use atmosphericModel.py
- atmospheric refraction example: jupyter notebook example - atmospheric refraction example: jupyter notebook example
- setup.py : Install script to install the AstroAtmosphere package locally.
**On the contents of the atmosphericModel package** **On the contents of the AstroAtmosphere package**
The package contains the following files: The package contains the following files:
- 1976USSA.txt : Data file of the 1976 US Standard Atmosphere. - 1976USSA.txt : Data file of the 1976 US Standard Atmosphere.
- ciddorModel.py : Contains the `Observatory()` class to calculate the refractive index of atmospheric air, using the Ciddor (1996) model. - ciddorModel.py : Contains the `Observatory()` class to calculate the refractive index of atmospheric air, using the Ciddor (1996) model.
@@ -63,7 +62,7 @@ Input parameters for the spherical atmosphere models (all but the first):
**Analytical error propagation** **Analytical error propagation**
Full analytical error propagation is available for the Ciddor dispersion model (Observatory.dn_tph( ) ), for the Cassini refraction model (refraction.cassiniError( ) ) and for the Cassini dispersion model (dispersion.cassiniError( ) ). Full analytical error propagation is available for the Ciddor dispersion model (`Observatory.dn_tph()`), for the Cassini refraction model (`refraction.cassiniError()`) and for the Cassini dispersion model (`dispersion.cassiniError()`).
The results agree well with a Monte Carlo simulation, suggesting that if additional errors have not been considered, they are of neglible importance. The results agree well with a Monte Carlo simulation, suggesting that if additional errors have not been considered, they are of neglible importance.
Uncertainties that are considered: Uncertainties that are considered:
@@ -97,4 +96,4 @@ Cassini dispersion model:
| dRH | Relative Humidity | | | dRH | Relative Humidity | |
| dCO2 | CO2 density | ppm | | dCO2 | CO2 density | ppm |
| dz | Zenith angle | deg | | dz | Zenith angle | deg |