diff --git a/README.md b/README.md index d738493..60ee3a3 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ pip install AstroAtmosphere ``` -##Contents of the AstroAtmosphere package +## Contents of the AstroAtmosphere package The package contains the following files: - `/data/1976USSA.txt` : Data file of the 1976 US Standard Atmosphere. @@ -65,7 +65,7 @@ The package contains the following files: - `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). -##The Ciddor refractivity model +## The Ciddor refractivity model The refractivity model from Ciddor, 1996, calculates the index of refraction of air using the following parameters: - T - Temperature in Kelvin @@ -83,7 +83,7 @@ n = at.n_tph(l=0.55, T=273.15, p=101325, RH=0.2, xc=300) Basic functionality of other refractivity models is included as well and is discussed below. -##The atmospheric refraction and atmospheric dispersion models +## The atmospheric refraction and atmospheric dispersion models If the atmospheric refraction is denoted as R(n), then atmospheric dispersion is defined as R(n1) - R(n2). Thus they are very similar in function and also in use. @@ -122,7 +122,7 @@ atm_ref = ref.cassini(n, zenith=30) ``` -##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()`). The results agree well with a Monte Carlo simulation, suggesting that if additional errors have not been considered, they are of neglible importance. @@ -173,7 +173,7 @@ dispersion_unc = disp.cassiniError(zenith_obs, l1, l2, T, P, H, xc, dl1=0.001, dl2=0.001, dT=0.2, dP=30, dRH=0.03, dCO2=25, dz=1/3600) * 3.6e6 ``` -##Other refractivity models +## Other refractivity models The package also includes limited functionality of other refractivity models. These are not as extensive, work only under standard atmospheric conditions, or over a limited wavelength range, compared to the Ciddor model. @@ -192,7 +192,7 @@ Included are The last function extracts the refractive index from the `pyslalib.sla_refro()` function and thus requires [pyslalib](https://pypi.org/project/pySLALIB/). This is an optional dependency for the setup of AstroAtmosphere. -##Quick functions +## Quick functions Some functions that assume default conditions for the atmosphere. Then only the wavelength and zenith angle are required to calculate the refraction and dispersion. @@ -207,4 +207,4 @@ rq = quick_refraction(l1, zenith_obs, conditions='STANDARD') # Quick dispersion dq = quick_dispersion(l1, l2, zenith_obs, conditions='STANDARD') -``` \ No newline at end of file +```