From: ccmproc2@neit.cgd.ucar.edu (Lawrence Buja)
Message-Id: <199402141735.KAA00382@sunny.cgd.ucar.edu>
Subject: On-line Processor documentation.
To: ccm-users@ncar.UCAR.EDU (CCM Mail Group)
Date: Mon, 14 Feb 94 10:35:26 MST
ON-LINE CCM PROCESSOR DOCUMENTATION.
------------------------------------
The documentation for the CCM Processor is now available online via
gopher, Xgopher and Mosaic to:
/North America/Colorado/NCAR/NCAR-UCAR Gophers/CGD/Processor/...
This will be the "current" version of the documentation.
---
The main Processor gopher directory looks like:
1. About the CCM Processor.
2.
3. Getting Started: An introduction to the Processor./
4.
5. General Discussions of Topics./
6.
7. Processor ICPs: Dictionary./
8. Processor ICPs: Grouped by Subject./
9.
10. Sample Processor Codes./
11. Getting Help./
(In gopher a trailing / indicates that the entry is a sub-directory with
more files below. In Xgopher, sub-directories are prefixed with a >>.
Blank lines are used for formatting.)
1. is a short informational file about the Processor
3. is the contents of the introductory text from NCAR/TN-383+IA
"Introduction to the UNICOS CCM Processor"
5 is the first half of NCAR/TN-384+IA "CCM Processor Users' Guide
(UNICOS Version)" where the general topics of Processor usage
are discussed.
7 is the second half of NCAR/TN-384+IA "CCM Processor Users' Guide
(UNICOS Version)" consisting of all the ICPs in alphabetical order.
8. is discussed below.
10. contains sample Processor codes. The various Processor sample codes
from the printed documentation can be found here. A directory for
unsupported Processor "tools" also exists. The unsupported tools
directory will archive useful Processor tools that users post to the
ccm-users mail-group. Please clearly document any codes that you
submit since I won't provide any support/consulting for any of these
codes. See the example of chgheader.sh as a commenting guide.
11. essentially says to read the documentation and e-mail for help
only if you have a documentable bug report.
---
Section 8. is probably the most useful section. It consists of
cross-links to portions of 5., 7. and 10., linked according to
subjects. The various subjects areas are:
1. Data Input/
2.
3. Case Comparison and Merging/
4. Derived Fields/
5.
6. Time Averaging and Filtering/
7. Spatial Averaging/
8. Surface Type Masking/
9.
10. Vertical Interpolation/
11. Spectral Processing/
12. List Sorted Data (LSD) Driver/
13.
14. Data Output: Graphics./
15. Saving/Printing Selected Data./
Typically, the subject areas will consist of a General Discussion
of the topic, followed by the associated ICPs, followed by a couple
of relevant examples codes of ICPs that you can copy and ended with
a pointer back to the Processor home page.
For example, subject 8. Surface Type Masking/ looks like:
1. SURFACE TYPE MASKING: General discussion..
2. Mask the input data by surface type flags. (MASKSc).
3. Masked area average specification (A,B). (MSKFLcn).
4. Compute ordinary masked area averages. (MSKAP).
5. Compute masked area average of the squares. (MSKAPS).
6. Compute masked area ave of squares of zonal aves. (MSKAZS).
7. Print masked area averages with time series plots. (MSKAVPR).
8. Name of surface type save tape to read. (SFCTTAP).
9. Name of surface type save tape to create. (SFCTCRT).
10.
11. Example: Process data over land only using a simple land mask.
12.
13. Processor home page./
1-11 are all individual files that you can select, read and copy.
13 is the pointer back to the Processor home page directory.
---
If you anticipate using gopher/Xgopher often, the bookmark options offer
a quick way of getting to the Main Processor directory
Coming soon:
Once the indexing software is installed here, the capability to do
searches for text strings in the Processor documentation will be added.
End