From eee6181d26d210bc0a5ed80a71b4e569ea303311 Mon Sep 17 00:00:00 2001
From: Joost van den Born <born@astron.nl>
Date: Fri, 5 Apr 2019 10:56:53 +0200
Subject: [PATCH] Add README.md

---
 README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7e5c5e0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+Here you can find a set of models describing the atmospheric refraction and dispersion. 
+
+Contents:
+- atmosphericModel.py           : Python model that can be used to calculate the atmospheric refraction and dispersion
+- refractionModel.py            : Python script that compares the output of the different rerfraction models. 
+                                  Can be used as an example on how to use atmosphericModel.py
+- 1976USSA.txt                  : Table with temperature, pressure, density and more as a function of altitude.
+                                  Values derived from the 1976 U.S. Standard Atmosphere.
+- manual.pdf                    : Manual for using atmosphericModel.py
+- atmospheric refraction example: jupyter notebook example
+- [Tech note]...models.pdf      : Tech note describing the models.
+
+
+
+On the dispersion model:
+Dispersion model from Ciddor, 1996, calculates the index of refraction of air using the following parameters:
+- Temperature
+- Pressure
+- Relative humidity
+- CO2 density
+
+
+
+
+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)
+- Plane-parallel atmosphere refraction model
+- Cassini's homogeneous atmosphere refraction model
+- Oriani's theorem ( A*tan(z) + B^*tanˆ^3(z) )
+- Oriani's theorem expanded ( A*tan(z) + B*tanˆ^3(z) + C*tan^5(z)  )
+- Error function refraction model
+
+
+
+
+Input parameters for the spherical atmosphere models (all but the first):
+- Temperature               [K]
+- Pressure                  [Pa]
+- Relative humidity
+- CO2 density               [ppm]
+- Latitude                  [deg]
+- Height above sea level    [m]
+- Wavelength(s)             [um]
+- Zenith angle              [deg]
\ No newline at end of file