From 16fc562304063bff10e5bde9b89256466e967388 Mon Sep 17 00:00:00 2001 From: Joost van den Born Date: Wed, 27 May 2020 15:49:42 +0200 Subject: [PATCH] Update README.md --- README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index f2bfb9d..60b6035 100644 --- a/README.md +++ b/README.md @@ -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.* **Contents:** -- atmosphericModel : Python model 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 +- AstroAtmosphere : Python package that can be used to calculate the atmospheric refraction and dispersion, the main content of this repository. - 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: - 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. @@ -63,7 +62,7 @@ Input parameters for the spherical atmosphere models (all but the first): **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. Uncertainties that are considered: @@ -97,4 +96,4 @@ Cassini dispersion model: | dRH | Relative Humidity | | | dCO2 | CO2 density | ppm | | dz | Zenith angle | deg | - \ No newline at end of file +