Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

corrected a few minor mistakes in the README file

  • Loading branch information...
commit f633e446832449e16150b595bd74f1077262711d 1 parent 0db136d
@skendrew authored
Showing with 16 additions and 14 deletions.
  1. +16 −14 README
View
30 README
@@ -2,7 +2,7 @@ MIDIR_SENSITIVITY REPOSITORY
****************************
What is it?
------------
+--------------
This repository contains idl code to calculate the sensitivity of a ground-based mid-infrared instrument for astronomy. The code was written during 2008-2009 for the Phase A study of the instrument METIS (http://www.strw.leidenuniv.nl/metis), the Mid-Infrared E-ELT Imager and Spectrograph, for the 42-m European Extremely Large Telescope. The code and all input parameters are highly tailored for the particular design parameters of the E-ELT and METIS, however, the programme is structured in such a way that the parameters can easily be adjusted for a different system, or alternative input files used.
Basic features of the E-ELT and METIS are:
@@ -11,17 +11,17 @@ Basic features of the E-ELT and METIS are:
- a ground-based telescope, i.e. contributions from atmospheric radiance and a strong thermal background from the telescope
- adaptive optics for atmospheric turbulence correction using either single conjugate natural guide star AO (aomode='scao') or laser guide star tomographic AO (aomode='ltao')
- instrument performance is assumed to be thermal background-limited at all wavelengths, in all modes. The METIS instrument is cryogenically cooled to achieve this
-- two sites are considered according to the info provided by ESO at
+- two sites are considered according to the info provided by ESO at http://www.eso.org/sci/facilities/eelt/science/drm/tech_data/background/
What is it not?
---------------
-- the code does not generate synthetic images of spectra
+- the code does not generate synthetic images or spectra
- no coronagraphic or polarimetric observing modes
- no specific detector readout schemes or subarrays
Contents
---------
+-----------
The package contains 3 key files for sensitivity calculations in METIS' 3 main modes of observation:
1. metis_img_sn.pro -> Imager mode
- Imager specific parameter file: metis_sens_img_param.pro
@@ -37,7 +37,7 @@ Zip files
There are three zip files which each contain all the files you need for a particular mode of observation, as above.
Dependencies
-------------
+---------------------
Parameter files:
- metis_sens_param.pro: general input parameters related to telescope and atmosphere. Contains parameters for setting file locations to be adjusted for your own system
@@ -48,7 +48,7 @@ Atmospheric profiles:
- atm/high_and_dry_*.dat: dito Paranal for a high & dry site at 5000 m
Encircled energy lookup tables:
-- ee_files/: this folder contains 2 lookup tables for AO-corrected encircled energies. (i) EnsquaredEnergy_AO_LMN_V10.dat is for single conjugate AO and is calculated with AO simulation tool PAOLA. Please refer to the tech note by Kendrew for detailed input details; (ii) atlas_eeav.dat is the same for the laser tomography AO mode, provided by the team designing the LTAO module for E-ELT at ONERA, France. These values are encircled energies instead of ensquared, so take care to compare. See tech note for more info.
+- ee_files/: this folder contains 2 lookup tables for AO-corrected encircled energies. (i) EnsquaredEnergy_AO_LMN_V10.dat is for single conjugate AO and is calculated with AO simulation tool PAOLA. Please refer to the tech note by Kendrew for detailed input details; (ii) atlas_eeav.dat is the same for the laser tomography AO mode, provided by the team designing the LTAO module for E-ELT at ONERA, France. These values were converted from encircled to ensquared energies, and this introduces a marginal error. See tech note for more info.
Profiles:
The profiles/ folder contains a number of input files loosely grouped for being "profiles" of sorts.
@@ -69,19 +69,19 @@ Auxiliary functions:
Requirements
-------------
-This code was written using IDL 7.0 under Windows XP SP3 and should be compatible with most reasonably current versions of IDL. I've also used it regularly under linux, which requires some minor modifications to the directory structure. The input directories are specified in the metis_sens_param.pro file.
+-------------------
+This code was written using IDL 7.0 under Windows XP SP3 and should be compatible with most reasonably current versions of IDL (> 6.x) although I haven't tested it extensively. I've used it regularly under linux, which requires some minor modifications to the directory structure. The input directories are specified in the metis_sens_param.pro file.
The IDL Astronomy Library is referenced throughout - you can download it here:
http://idlastro.gsfc.nasa.gov/ftp/
Who wrote it?
--------------
+-------------------
This code was written by Sarah Kendrew, Postdoc in Astronomy Instrumentation at Leiden Observatory, PO Box 9513, 2300 RA Leiden, during 2008-2009. For more info, you can contact me on sarahaskendrew@gmail.com.
-Acknowledgment
---------------
+Referencing
+----------------
If you use this code, either for METIS-specific calculations or for your own project, please cite:
Kendrew et al., Proc. SPIE, in preparation (2010)
-- this paper will be presented at SPIE San Diego 2010 so I'll update the reference asap.
@@ -89,7 +89,7 @@ Kendrew et al., Proc. SPIE, in preparation (2010)
If you use the code extensively, I'd like to hear about it and would appreciate being added as a co-author to any resulting publications.
Further reading
----------------
+-------------------
A detailed description of the calculation method, inputs and results for METIS are in the tech note in the repository by Kendrew, 2009. The calculation method is based on that of the E-ELT exposure time calculator provided by ESO, albeit with quite different inputs, freely available via the ESO E-ELT Design Reference Mission:
http://www.eso.org/sci/facilities/eelt/science/drm/cases.html.
@@ -99,7 +99,9 @@ For more information about the METIS instrument and project, see http://www.strw
Acknowledgements
-----------------
+-------------------------
S. Kendrew was funded by NOVA, the Dutch Research School for Astronomy, when this work was carried out.
+METIS is an international collaboration of NOVA (Leiden/Dwingeloo, NL), the Max Planck Institute for Astronomy (Heidelberg, D), CEA Saclay (Paris, F), the UK Astronomy Technology Centre (Edinburgh, GB) and the KU Leuven (Leuven, B).
+
---- Sarah Kendrew, 29 March 2010
+--- S. Kendrew, 2010
Please sign in to comment.
Something went wrong with that request. Please try again.