aboutsummaryrefslogtreecommitdiff
path: root/noao/imred/doc/demos.hlp
diff options
context:
space:
mode:
authorJoe Hunkeler <jhunkeler@gmail.com>2015-08-11 16:51:37 -0400
committerJoe Hunkeler <jhunkeler@gmail.com>2015-08-11 16:51:37 -0400
commit40e5a5811c6ffce9b0974e93cdd927cbcf60c157 (patch)
tree4464880c571602d54f6ae114729bf62a89518057 /noao/imred/doc/demos.hlp
downloadiraf-osx-40e5a5811c6ffce9b0974e93cdd927cbcf60c157.tar.gz
Repatch (from linux) of OSX IRAF
Diffstat (limited to 'noao/imred/doc/demos.hlp')
-rw-r--r--noao/imred/doc/demos.hlp77
1 files changed, 77 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