From 1819c5f63285a93ad623f054e03bedbcfa345e52 Mon Sep 17 00:00:00 2001 From: Joost van den Born Date: Thu, 28 May 2020 10:25:37 +0200 Subject: [PATCH] Update README.md --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 60b6035..f3d6160 100644 --- a/README.md +++ b/README.md @@ -12,17 +12,17 @@ Author info: *Joost van den Born*, *born@astron.nl* **Contents:** - 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. +- `setup.py` : Install script to install the AstroAtmosphere package locally. **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. -- dispersionModels.py : Contains various atmospheric models that can be used to calculate the atmospheric dispersion -- examples.py : Contains several quick functions, e.g. to quickly calculate the refractive index. -- refractionModels.py : Contains various atmospheric models that can be used to calculate the atmospheric refraction -- refractivityModels.py : Contains various functions from literature to calculate the refractive index. Some examples of works included are Ciddor (1996), Barrell & Sears (1939), SLALIB, Owens (1967) and Edlen (1966). +- `/data/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. +- `dispersionModels.py` : Contains various atmospheric models that can be used to calculate the atmospheric dispersion +- `examples.py` : Contains several quick functions, e.g. to quickly calculate the refractive index. +- `refractionModels.py` : Contains various atmospheric models that can be used to calculate the atmospheric refraction +- `refractivityModels.py` : Contains various functions from literature to calculate the refractive index. Some examples of works included are Ciddor (1996), Barrell & Sears (1939), SLALIB, Owens (1967) and Edlen (1966). **On the dispersion model:** @@ -39,7 +39,7 @@ Dispersion model from Ciddor, 1996, calculates the index of refraction of air us **On the atmospheric refraction / atmospheric dispersion models:** Available models: -- Full integration using the refractive integral (requires detailed information about the atmosphere, e.g. 1976USSA.txt) +- Full integration using the refractive integral (requires detailed information about the atmosphere, e.g. `AstroAtmosphere/data/1976USSA.txt`) - Plane-parallel atmosphere refraction model - Cassini's homogeneous atmosphere refraction model - Oriani's theorem ( Atan(z) + Btan^3(z) )