aboutsummaryrefslogtreecommitdiff
path: root/noao/imred/doc
diff options
context:
space:
mode:
Diffstat (limited to 'noao/imred/doc')
-rw-r--r--noao/imred/doc/demos.hlp77
-rw-r--r--noao/imred/doc/revisions.v2.ms89
-rw-r--r--noao/imred/doc/tutor.hlp64
3 files changed, 230 insertions, 0 deletions
diff --git a/noao/imred/doc/demos.hlp b/noao/imred/doc/demos.hlp
new file mode 100644
index 00000000..35a32b6e
--- /dev/null
+++ b/noao/imred/doc/demos.hlp
@@ -0,0 +1,77 @@
+.help demos Sep90
+.ih
+NAME
+demos -- Demonstration and Test Procedures
+.ih
+PACKAGES
+noao.imred.argus, noao.imred.goldcams, noao.imred.kpcoude.fiber
+noao.imred.kpcoude.slit, noao.imred.nessie, noao.imred.specred
+noao.twodspec.longslit
+.ih
+USAGE
+demos demoname
+.ih
+PARAMETERS
+.ls demoname
+Demonstration or test procedure name. Each package may have a different
+set of demonstrations. If the demo name is not specified on the command
+line a menu of names is printed and then the name is queried.
+.le
+.ih
+DESCRIPTION
+Many packages have demonstration and test procedures. These are generally
+based on artificial data and use the \fIstty playback\fR (see \fBstty\fR)
+mechanism of the CL. A playback replaces interactive terminal input
+with previously stored input but otherwise is an actual execution of
+the entered commands. This allows both demonstration of various types
+and an actual test of the software on a particular IRAF system.
+
+Generally the \fBdemos\fR procedures create their own data if not present
+from a previous execution. After the procedure is completed the data,
+logfiles, etc. are left so that they may be examined further and
+the user may try some experiments. Thus, it might be useful to create
+a new directory for the demo using \fBmkdir\fR and "cd" to it.
+
+Currently, most of the demos are test procedures which do not contain
+comments and suitable delays to act as a demonstration. These will
+be added in time. Also some of the demos just create the demo/test
+data if one just wants some relevant data for experimentation with
+the package.
+
+One should be aware that since the tasks are actually run parameters
+are sometimes changed.
+.ih
+EXAMPLES
+1. From the \fBgoldcam\fR package list the menu and execute the
+qtest demo.
+
+.nf
+ go> mkdir demo
+ go> cd demo
+ go> demos
+ MENU of GOLDCAM Demonstrations
+
+ qtest - Quick test of GOLDCAM (no comments, no delays)
+
+ Demo name (qtest):
+ <Demo follows>
+.fi
+
+2. From the \fBnessie\fR package create some simple test data.
+
+.nf
+ ne> demos mkqdata
+ Creating image demoobj ...
+ Creating image demoflat ...
+ Creating image demoarc1 ...
+ Creating image demoarc2 ...
+ ne> demos mkqdata
+ ne>
+.fi
+
+Note that the second execution does not create the data again.
+
+.ih
+SEE ALSO
+artdata.mkexamples, ccdred.ccdtest.demo
+.endhelp
diff --git a/noao/imred/doc/revisions.v2.ms b/noao/imred/doc/revisions.v2.ms
new file mode 100644
index 00000000..50036911
--- /dev/null
+++ b/noao/imred/doc/revisions.v2.ms
@@ -0,0 +1,89 @@
+.nr PS 9
+.nr VS 11
+.RP
+.ND
+.TL
+IMRED Package Revisions Summary: IRAF Version 2.10
+.AU
+Francisco Valdes
+.AI
+IRAF Group - Central Computer Services
+.K2
+P.O. Box 26732, Tucson, Arizona 85726
+September 1990
+.AB
+This paper summarizes the changes in Version 2 of the IRAF \fBimred\fR
+package which is part of IRAF Version 2.10. The major changes are:
+
+.IP \(bu
+New multifiber reduction packages \fBargus\fR, \fBnessie\fR, and
+\fBkpcoude.fiber\fR.
+.IP \(bu
+New spectrophotmetric slit spectra reduction packages \fBgoldcam\fR,
+\fBspecred\fR, and \fBkpcoude.slit\fR.
+.IP \(bu
+New versions of the \fBmsred\fR and \fBechelle\fR packages based on
+the new versions of \fBapextract\fR and \fBonedspec\fR.
+.AE
+.NH
+Introduction
+.PP
+A number of new specialized image reduction packages and new versions
+of the generic echelle and multiobject spectroscopy packages have been
+added to the \fBimred\fR package in IRAF Version 2.10. The new
+subpackages will be made available as external packages prior to
+the release of V2.10. The major changes are:
+
+.IP \(bu
+New multifiber reduction packages \fBargus\fR, \fBnessie\fR, and
+\fBkpcoude.fiber\fR.
+.IP \(bu
+New spectrophotmetric slit spectra reduction packages \fBgoldcam\fR,
+\fBspecred\fR, and \fBkpcoude.slit\fR.
+.IP \(bu
+New versions of the \fBmsred\fR and \fBechelle\fR packages based on
+the new versions of \fBapextract\fR and \fBonedspec\fR.
+
+.LP
+In additions there have been some minor changes in the other
+spectroscopy packages required by changes in the \fBonedspec\fR package.
+.PP
+The new packages are specialized to specific instruments or types of
+data. They contain tasks collected from the various general spectroscopy
+packages which are appropriate for a particular type of data.
+However, the most important contribution of these packages are
+special reduction tasks which are streamlined to perform the complete
+calibration and reduction of the data in as simple and automated
+manner as possible. The tasks combine operations from both two
+dimensional extraction and one dimensional spectral calibrations
+and collects all the useful parameters in two parameter sets while
+fixing and hiding parameters which are irrelevent.
+.PP
+The new packages are as follows. The \fBargus\fR package is for the
+flat fielding, throughput correction, extraction, dispersion correction,
+and sky correction of data from the CTIO \fIArgus\fR multifiber instrument.
+The \fBnessie\fR package is similar and is for the KPNO \fINessie\fR
+multifiber plugboard instrument. The \fBkpcoude.fiber\fR package is
+specialized for the three fiber (two arc and one object) instrument
+at the KPNO Coude. It is similar to the other multifiber packages
+except there is no sky subtraction.
+.PP
+The other three packages are for sky subtracted extraction,
+dispersion correction, extinction correction, and flux calibration
+of slit instruments. The packages are for the KPNO \fIGoldcam\fR,
+the KPNO Coude, and for the CTIO \fI2DFRUTTI\fR. They are all
+fairly general and could be used for other instruments. They are
+distinguished by choices of default parameters.
+.PP
+There are user's guides for the powerful new reduction tasks in
+the new packages. These are available both as nicely typeset
+documents and as on-line IRAF manual pages.
+.PP
+Tasks from the revised \fBapextract\fR and \fBonedspec\fR packages
+appear in many of the \fBimred\fR packages. In particular the
+\fBechelle\fR and \fBmsred\fR packages are now based on this new
+software.
+.PP
+Some minor changes are the replacement of the \fBspecphot\fR package
+by \fBspecred\fR and the renaming and reorganization of the
+\fBcoude\fR package.
diff --git a/noao/imred/doc/tutor.hlp b/noao/imred/doc/tutor.hlp
new file mode 100644
index 00000000..21684194
--- /dev/null
+++ b/noao/imred/doc/tutor.hlp
@@ -0,0 +1,64 @@
+.help tutor Aug86 noao.imred
+.ih
+NAME
+tutor -- Present tutorial help on a particular package
+.ih
+USAGE
+tutor topic
+.ih
+PARAMETERS
+.ls topic
+Topic for which help is desired. If no topic is given then available
+topics are presented. The topic "all" prints all the topics.
+.le
+.ls package = ""
+Package for which tutorial help is desired. If null then the tutorial
+for the current package is presented.
+.le
+.ls tutordb = "helpdb"
+The filename of the tutorial database to be searched. If the \fIvalue\fR of the
+parameter is the reserved string "helpdb", the actual filename is the value
+of the CL environment variable \fIhelpdb\fR.
+.le
+.ih
+DESCRIPTION
+This task provides a tutorial facility for some of the IRAF packages.
+The tutorial consists of a number of topics
+which are obtained by typing "tutor topic" where topic is one of the
+available topics. If no topic is given then the available topics are
+presented. The topic "all" presents all the topics.
+
+This task is implemented using the \fBhelp\fR task. Therefore,
+modifying the \fBhelp\fR parameters dealing with the device and print
+format will also determine the output of \fBtutor\fR. The tutorial
+topic material is contained in the file Tutorial.hlp for each package.
+The database containing the directory to the tutorial files may or may
+not be the same as the standard help database.
+.ih
+EXAMPLES
+To get started:
+
+ cl> tutor
+
+To get help on reading and writing data tapes:
+
+ cl> tutor dataio
+
+To read all the topics:
+
+ cl> tutor all
+.ih
+BUGS
+Piping the output of \fBtutor\fR to lprint does not work properly because
+\fBhelp\fR is contained in a script.
+.ih
+TUTORIALS
+Tutorials are currently available only for the \fBechelle\fR package.
+This tutorial is in the process of being developed.
+.ih
+SEE ALSO
+.nf
+help
+Individual help pages for all the tasks mentioned in the tutorial.
+.fi
+.endhelp