Skip to main content
  • Home
  • Documentation
  • FAQ
  • Downloads
  • Support
  • Current Release Notes
  • Ferret Users Guide
    • Users Guide Index
    • Commands Reference
    • 1. Introduction
    • 2. Data Set Basics
    • 3. Variables & Expressions
    • 4. Grids & Regions
    • 5. Animations & Gif Images
    • 6. Customizing Plots
    • 7. Handling String Data Symbols
    • 8. Working with Special Data Sets
    • 9. Computing Environment
    • 10. Converting to NetCDF
    • 11. Writing External Functions
    • Glossary
    • Appendix A: Functions
    • Appendix B: PPLUS Guide
    • Appendix C: Ferret-Specific PPLUS Enhancements
  • Previous Release Notes
  • Tutorials and Demos
    • Ferret Tour
    • DSG files: Discrete Sampling Geometries Demo
    • Ferret sorting demo
    • Fast Fourier Transforms demo
    • Empirical Orthogonal Functions demo
    • Ferret objective analysis demo
    • Ferret Palette Demo
    • Map projections
    • Ferret polygon vector demo
    • Ferret Graticules demo
    • Ferret Polytube Demo
    • Ferret Polymark Demo
    • Ferret Constant-Array demo
    • Ferret land_detail demo
    • COADS Tour
    • Levitus Tour
    • Use OPeNDAP
    • Ferret binary read demo
  • PyFerret
    • PyFerret Downloads and Install ../../faq/ferret-faqs.html
    • What is PyFerret?
    • Why use PyFerret?
    • PyFerret for the Ferret user
    • PyFerret command syntax: quick-start notes
    • PyFerret for the Python user
    • Graphics in PyFerret ?
    • New Ferret functionality
    • PyFerret Python functions and constants
    • PyFerret Python objects and methods
    • Ferret external functions in Python
    • Ferret Fortran external functions
    • PyFerret metadata-and-data dictionaries
  • OPeNDAP
    • OPeNDAP usage in Ferret
    • Use OPeNDAP Demo
    • Test OPeNDAP

SHOW

Ref Sec33.

SHOW

/ALL

Displays program states and stored values.

Command qualifiers for SHOW:

SHOW/ALL
Executes all SHOW options. This command gives a complete description of the current state, including information about region, grids, axes, variables, and the state of various modes (default or set with SET MODE).

yes? SHOW/ALL

Arguments:

The names of variables, data sets, or other definitions can be specified using wildcards. The * wildcard matches any number of characters in the name; the question wildcard matches exactly one character.

 

Ref Sec33.1.

 

SHOW ALIAS

Lists all command aliases and the full command names for which they stand, or, with an argument, shows a specified command alias.

yes? SHOW ALIAS [alias_name]

 

 

Ref Sec33.2.

 

 

SHOW ATTRIBUTE

/ALL /DATASET /OUTPUT

yes? SHOW ATTRIBUTE varname.attname

yes? SHOW ATTRIBUTE/ALL varname

yes? SHOW ATTRIBUTE/D=1/ALL varname

yes? SHOW ATTRIBUTE/OUTPUT varname

Shows the attribute(s) for a variable. This command is included for convenience; it does not add any capabilities beyond the LIST command, but is useful especially with the /ALL qualifier for a quick look at what attributes a variable has. The /OUTPUT qualifer adds to each line the flag showing whether the attribute is marked for writin to netCDF files.

See the section on access to dataset and variable attributes.

Simplified versions of this command:

yes? SHOW ATTRIBUTE datset_specifier ! acts the same as SHOW DATA/ATTRIBUTES dataset

yes? SHOW ATTRIBUTE varname ! acts the same as SHOW ATTRIBUTE/ALL varname

 

 

 

Ref Sec33.3.

 

SHOW AXIS

Shows a basic description of the named axis.

SHOW AXIS[/qualifiers] axis_name

A typical output appears below. The columns are:

name

name of axis (used also in DEFINE AXIS and DEFINE GRID)

# pts

number of points on axis; "r" or "i" for regular or irregular spacing, "m" if the axis is "modulo" (repeating)

axis

the orientation of the axis; "(-)" after the "r" or "i" on a depth axis indicates increasing downward

start

position of first point on the axis

end

position of last point on the axis

 

 

 

 

The axis span (length of the axis), and for modulo axes, the modulo length are also given.

 

 

 

 

yes? SHOW AXIS PSXT
name axis # pts start end
PSXT LONGITUDE 160 r 130.5E 70.5W
Axis span (to cell edges) = 360 (modulo length = axis span)

 

yes? SHOW AXIS/I=1:2 COADSX
name axis # pts start end
COADSX LONGITUDE 180mr 21E 19E(379) 
Axis span (to cell edges) = 360 (modulo length = axis span)
I X XBOX XBOXLO
1> 21E 2 20E
2> 23E 2 22E

Command qualifiers for SHOW AXIS:

SHOW AXIS/I=/J=/K=/L=/M=/N=/X=/Y=/Z=/T=/E=/F=/XML/OUTFILE/APPEND/CLOBBER
Displays the coordinates and grid box sizes for the specified axis. Optionally, low and high limits and a delta value may be specified to restrict the range of values displayed.

yes? SHOW AXIS/X[=lo:hi:delta] axis-name

To list dates in ISO 8601 time format, first issue the command SET MODE DATE_FORMAT:ISO

Example:

yes? SHOW AXIS/L=1:12:3 my_custom_time_axis

SHOW AXIS/ALL
Show a brief summary of all axes defined.

yes? SHOW AXIS/ALL

SHOW AXIS/XML
List the axis information in XML-style

yes? SH AXIS/XML fnocx
<axis name="FNOCX">
<units>degrees_east</units>
<length>144</length>
<start>20E</start>
<end>17.5E(377.5)</end>
<point_spacing>even</point_spacing>
<modulo>yes</modulo
</axis>

 

SHOW AXIS/XML/OUTFILE=filename.xml/APPEND/CLOBBER
These qualifiers are for writing the xml output of SHOW AXIS/XML to a file, and controlling whether that file is new (/CLOBBER) or an existing file to be added to (/APPEND).

 

 

Ref Sec33.4.

SHOW COMMANDS

/ALL /BRIEF

Displays commands, sub-commands, and qualifiers recognized by program Ferret. This command does not display aliases; use SHOW ALIAS.

SHOW COMMAND [command_name or partial_command]

Note: This is the most reliable way to view command qualifiers. The output of this command will be current even when this manual is out of date.

/ALL lists all of the commands. This is the default.

/BRIEF lists only the command and sub-command names, with no qualifiers.

Examples:

yes? SHOW COMMAND             ! show all commands 
yes? SHOW COMMAND SH          ! show the first command matched that starts with "S" (the SET command).  
yes? SHOW COMMAND PLOT        ! shows command PLOT and all its qualifiers
 
yes? SHOW COMMAND SHO DAT     ! shows only the sub-command SHOW DATA and its qualifiers
yes? SHOW COMMAND/BRIEF       ! show only the commands
yes? SHOW COMMAND/BRIEF SHOW  ! show only the SHOW command, with its sub-commands, but no qualifiers.

 

 

Ref Sec33.5.

 

 

SHOW DATA_SET

/ALL /BRIEF /MEMBERS /FULL /VARIABLE /ATTRIBUTES /XML /OUTFILE /APPEND /CLOBBER

Shows information about the data sets which have been SET and indicates the current default data set. By default the variables and their subscript ranges are also listed.

yes? SHOW DATA[/qualifiers] [set_name_or_number1,set2,...]

If no data set name or number is specified then all SET data sets are shown.

If an ENSEMBLE or FMRC aggregation is defined, then the dataset number may be given as agg.member; that is if the aggregation is datset 12, then "SHOW DATA 12.3" lists information about member number 3 of the aggregation.

 

Command qualifiers for SHOW DATA_SET:

SHOW DATA/ALL
This qualifier has no effect on this command; it exists for compatibility reasons.

SHOW DATA/ATTRIBUTES
SHOW ATTRIBUTES dataset
Makes an expanded listing which includes the global and variable attributes, the attribute types, sizes, and the output flag for each (See the section on access to dataset and variable attributes.

SHOW DATA/BRIEF
Shows only the names of the data sets; does not describe the data contained in them.

SHOW DATA/MEMBERS
Displays the names of the data files for this data set and the ranges of time steps contained in each. Output is formatted as date strings or as time step values depending on the state of MODE CALENDAR. Previously this qualifier was /FILES, which is deprecated.  If SHOW DATA/MEMBERS/BRIEF lists only the dataset names for the member datasets.

SHOW DATA/FULL
Equivalent to /VARIABLES and /FILES used together.

SHOW DATA/HIDDEN
If an ensemble (or aggregate) dataset has been defined with DEFINE DATA/HIDE, then the member datasets will be hidden by default on a SHOW DATA command. SHOW DATA/HIDDEN causes all open datasets to be shown.

SHOW DATA/VARIABLES
In addition to the information given by the SHOW DATA command with no qualifiers, this query also provides the grid name and world coordinate limits for each variable in the data set.

SHOW DATA/XML
SHOW DATA/XML/OUTFILE=filename.xml/APPEND /CLOBBER
For netCDF files, including those accessed via DODS, SHOW DATA/XML and SHOW DATA/VAR/XML list information about the file and variables as xml-style output. The /OUTFILE, /APPEND /CLOBBER qualifiers allow for this output to be written to a file.

Example: SHOW DATA

SHOW DATA produces a listing similar to the one below. The output begins with the descriptor file name (for TMAP-formatted data) and data set title. The columns I, J, K, and L give the subscript limits for each variable with respect to its defining grid (use SHOW DATA/FULL and SHOW GRID variable_name for more information).  If the data had an E or F axis, all 6 dimensions would be shown

yes? SHOW DATA
currently SET data sets:
1> /home/users/tmap/ferret/linux/fer_dsets/data/levitus_climatology.cdf  (default)
name     title                             I         J         K         L
TEMP     TEMPERATURE                      1:360     1:180     1:20      ...
SALT     SALINITY                         1:360     1:180     1:20      ...

Example: SHOW DATA for Discrete Sampling Geometries (DSG) data

yes? use dsg_profile_example
yes? show data    1> /home/users/tmap/ferret/linux/fer_dsets/data/dsg_profile_example.nc  (default)
DSG Feature type Profile
name     title                             I         J         K         L         M         N
ID       profile id                       ...       ...       ...       ...       1:30      ...
ROWSIZE  Number of Observations for this  ...       ...       ...       ...       1:30      ...
LONGITUDE
station longitude                ...       ...       ...       ...       1:30      ...
LATITUDE station latitude                 ...       ...       ...       ...       1:30      ...
DEPTH    Depth                            ...       ...     tot 1268    ...       1:30      ...
TIME     Time                             ...       ...       ...       ...       1:30      ...
TEMP     Temperature                      ...       ...     tot 1268    ...       1:30      ...
SAL      Salinity                         ...       ...     tot 1268    ...       1:30      ...
SIGMA_T  Sigma-T                          ...       ...     tot 1268    ...       1:30      ...

The feature-type is noted, and the variables shown as either by-feature variables such as the ID, and observation variables with the total size of the contiguouis ragged array storage.  SHOW DATA/VARIABLES adds a block of text  at the end of the output summarizing the coordinate ranges for the coordinate data in the dataset.

 

Example: SHOW DATA/XML, SHOW DATA/VARIABLES/XML

Example:

yes? USE monthly_navy_winds
 
yes? SHOW DATA/XML
<dataset>
<title> </title>
<vname>UWND</vname>
<vname>VWND</vname>
</dataset>
 
yes? SHOW DATA/VAR/XML
<var name="UWND">
<units>M/S</units>
<long_name>ZONAL WIND</long_name>
<_FillValue>-99.9</_FillValue>
<missing_value>-99.9</missing_value>
<grid name="GDN1">
<xaxis>FNOCX</xaxis>
<yaxis>FNOCY</yaxis>
<taxis>TIME</taxis>
</grid>
</var>
<var name="VWND">
<units>M/S</units>
<long_name>MERIDIONAL WIND</long_name>
<_FillValue>-99.9</_FillValue>
<missing_value>-99.9</missing_value>
<grid name="GDN1">
<xaxis>FNOCX</xaxis>
<yaxis>FNOCY</yaxis>
<taxis>TIME</taxis>
</grid>
</var>

 

 

 

Ref Sec33.6.

 

 

SHOW EXPRESSION

Shows the current expression(s) implied or set with SET EXPRESSION. If not explicitly set with this command, the default current context expression is the argument of the most recent "action" command (PLOT, SHADE, CONTOUR, VECTOR, WIRE, etc.) See the chapter "Variables and Expressions", section "Expressions" for an explanation and list of action commands.

yes? SHOW EXPRESSION

 

 

Ref Sec33.7.

SHOW FUNCTION

/ALL /BRIEF /EXTERNAL /INTERNAL /DETAILS

Shows a complete list of the functions defined in Ferret including descriptions of the function arguments.

yes? SHOW FUNCTION[/qualifiers] [function_name]

If no qualifier or function name is given then all functions are listed. SHOW FUNCTION will accept name templates such as

yes? SHOW FUNCTION *days*
DAYS1900(year,month,day)
days elapsed since 1-Jan-1900
DAYS1900TOYMDHMS(day1900)
Convert Julian day to values y,m,d,h,m,s on k=1,...,6
day1900: Julian day counted from 1-jan-1900 

Parameters

The parameter(s) may be the name of a function, with * replacing part of the string as above.

Command qualifiers for SHOW FUNCTION:

SHOW FUNCTION/ALL
List all functions defined

SHOW FUNCTION/BRIEF
List the functions and their arguments in brief form; no function or argument descriptions.

SHOW FUNCTION/EXTERNAL
List only the available Ferret External Functions. However, this also lists functions that were developed as external functions but are now linked internally as part of the Ferret executable.

SHOW FUNCTION/INTERNAL
List only the internally defined Ferret functions.

SHOW FUNCTION/DETAILS
Lists the axis inheritance for grid-changing functions as well as the data types of the arguments and the result.

Example:.SHOW FUNCTION/DETAILS

yes? SHOW FUNCTION/DETAILS SAMPLEXY
SAMPLEXY(DAT_TO_SAMPLE,XPTS,YPTS)
Returns data sampled at a set of (X,Y) points, using linear interpolation
Axes of result:
X: ABSTRACT (result will occupy indices 1...N)
Y: NORMAL (no axis)
Z: inherited from argument(s)
T: inherited from argument(s)
E: inherited from argument(s)
F: inherited from argument(s)
DAT_TO_SAMPLE: variable (x,y,z,t,e,f) to sample (FLOAT)
Influence on output axes:
X: no influence (indicate argument limits with "[]")
Y: no influence (indicate argument limits with "[]")
Z: passed to result grid
T: passed to result grid
E: passed to result grid
F: passed to result grid
XPTS: X values of sample points (FLOAT)
Influence on output axes:
X: no influence (indicate argument limits with "[]")
Y: no influence (indicate argument limits with "[]")
Z: no influence (indicate argument limits with "[]")
T: no influence (indicate argument limits with "[]")
E: no influence (indicate argument limits with "[]")
F: no influence (indicate argument limits with "[]")
YPTS: Y values of sample points (FLOAT)
Influence on output axes:
X: no influence (indicate argument limits with "[]")
Y: no influence (indicate argument limits with "[]")
Z: no influence (indicate argument limits with "[]")
T: no influence (indicate argument limits with "[]")
E: no influence (indicate argument limits with "[]")
F: no influence (indicate argument limits with "[]")

Ref Sec33.8. SHOW GRID

/I/J/K/L/M/N /X/Y/Z/T/E/F /ALL /DYNAMIC

Shows the name and axis limits of a grid.

yes? SHOW GRID[/qualifiers] [var_or_grid1 var_or_grid2 ...]

Example: SHOW GRID for gridded data

(See the command SHOW AXIS, for an explanation of the columns.)

yes? SET DATA levitus_climatology
yes? SHOW GRID salt
GRID GMS1
name       axis              # pts   start                end                 subset
XAXLEVITR LONGITUDE          360mr   20.5E                19.5E(379.5)        full
YAXLEVITR LATITUDE           180 r   89.5S                89.5N               full
ZAXLEVITR DEPTH (m)           20 i-  0                    5000                full

Example: SHOW GRID for Discrete Sampling Geometries (DSG) data. The listing summarizes the coordinate ranges for the variable in the dataset.

yes? use dsg_profile_example
yes? SHOW GRID sal
GRID (G003)
DSG Feature type Profile
name       axis              # pts   start                end                 subset
normal    X
normal    Y
FEATURE_Z DEPTH (m)         1268 r-  0                    63                  Variable lengths
normal    T
FEATURES  E (instance)        30 r   1                    30                  full
normal    F
 
Dataset coordinates:
longitude range: 165.98399W(-165.98399) to 159.66029W(-159.66029)
latitude range: 70.601N to 71.82133N
depth range: 0 to 63
time range: 22-AUG-2012 17:25 to 26-AUG-2012 23:42

 

Parameters

The parameter(s) may be the name of one or more grid(s) or variable(s). If no parameter is given SHOW GRID displays the grid of the last variable accessed. This is the only mechanism to display the grid of an algebraic expression.

Note: To apply SHOW GRID to an algebraic expression it is necessary for Ferret to have evaluated the expression in a previous command. The command LOAD is useful for this purpose in some circumstances.

Command qualifiers for SHOW GRID:

SHOW GRID/I=/J=/K=/L=/M=/N=/X=/Y=/Z=/T=/E=/F=
Displays the coordinates and grid box sizes for the specified axis. Optionally, low and high limits and a delta value may be specified to restrict the range of values displayed. The argument may be an expression.

yes? SHOW GRID/X[=lo:hi:delta] [variable_or_grid]

Example:

yes? SHOW GRID/L=1:7 sst
yes? sh grid/L=1:4 sst
GRID GSQ1
name       axis              # pts   start                end                 subset
COADSX    LONGITUDE          180mr   21E                  19E(379)            full
COADSY    LATITUDE            90 r   89S                  89N                 full
normal    Z
TIME      TIME                12mr   16-JAN 06:00         16-DEC 01:20        full
normal    E
normal    F
 
L     T                   TBOX      TBOXLO                TSTEP (hour)
1>  16-JAN 06:00:00       730.485    01-JAN 00:45:27         366
2>  15-FEB 16:29:06       730.485    31-JAN 11:14:33         1096.485
3>  17-MAR 02:58:12       730.485    01-MAR 21:43:39         1826.97
4>  16-APR 13:27:18       730.485    01-APR 08:12:45         2557.455
 
yes? show grid/x=300:330:5 sst
GRID GSQ1
name       axis              # pts   start                end                 subset
COADSX    LONGITUDE          180mr   21E                  19E(379)            full
COADSY    LATITUDE            90 r   89S                  89N                 full
normal    Z
TIME      TIME                12mr   16-JAN 06:00         16-DEC 01:20        full
normal    E
normal    F
 
I     X                   XBOX      XBOXLO
140>  61W                   2          62W
145>  51W                   2          52W
150>  41W                   2          42W
155>  31W                   2          32W
 

 

The "subset" column in the output of SHOW GRID, new in Ferret v7, lists the status of the grid in the expression. For an axis that has been transformed using a transform that reduces that axis away, such as an @AVE, that is shown. If there is a subset of the axis, that information is listed.

 

yes? show grid sst[X=@ave,y=@ave]
GRID GSQ1
name       axis              # pts   start                end                 subset
COADSX    LONGITUDE          180mr   21E                  19E(379)            compressed
COADSY    LATITUDE            90 r   89S                  89N                 compressed
normal    Z
TIME      TIME                12mr   16-JAN 06:00         16-DEC 01:20        full
normal    E
normal    F
 
yes? SHOW GRID sst[x=180:200,y=-20:20,L=1:12:3]
GRID (G003)
name       axis              # pts   start                end                 subset
COADSX    LONGITUDE          180mr   21E                  19E(379)            9 pts
COADSY    LATITUDE            90 r   89S                  89N                 19 pts
normal    Z
(AX007)   TIME                 4 r   16-JAN-0000 06:00    16-OCT-0000 04:21   3 pts
normal    E
normal    F

Example:

SHOW GRID/ALL
Shows the names only of all grids defined.

yes? SHOW GRID/ALL

 

SHOW GRID/DYNAMIC
Shows the names of dynamic grids that are defined.

yes? SHOW GRID/DYNAMIC

 

SHOW GRID/XML gridname
SHOW GRID/XML/OUTFILE=filename.xml/APPEND /CLOBBER gridname

Shows the grid information in XML-style format. The /OUTFILE, /APPEND /CLOBBER qualifiers allow for this output to be written to a file.

yes? USE monthly_navy_winds
yes? SHOW GRID/XML gdn1
<grid name="GDN1">
<xaxis>FNOCX</xaxis>
<yaxis>FNOCY</yaxis>
<taxis>TIME</taxis>
</grid>

 

Ref Sec33.9.

 

SHOW LIST

Shows the current states of the LIST command.

yes? SHOW LIST

The qualifier /ALL may be used with this command but exists merely for compatibility reasons and has no effect.

 

Ref Sec33.10.

 

SHOW MEMORY

 

/ALL /FREE /PERMANENT /TEMPORARY /DIAGNOSTIC

 

Shows the state of the memory cache.

yes? SHOW MEMORY

Shows the current setting for the upper limit on memory allocation.

Note that the symbol FERRET_MEMORY also contains the current memory size setting:

yes? IF `($ferret_memory) LT 20` THEN SET MEM/SIZ=20

 

Command qualifiers for SHOW MEMORY:

SHOW MEMORY/ALL
Shows all variables currently cached in memory—permanent and temporary.

Example:

The output shows the file variable that has been loaded into memory, the user-defined variable "myvar", and the expressions that are part of the definition of "myvar".  There is a summary of the memory usage, and each variable is listed with its total size, the indices and world coordinates of its region.  If a split/gather operation was used in loading the variable, each of the chunks will be listed, along with the final result that was assembled from the chunks.  See Understanding Ferret Memory Management Concepts and Tools for further discussion.

yes? use coads_climatology
yes? let const = 3*123.54
yes? let myvar = const* sst[L=@ave]
yes? shade myvar
 
yes? show memory/all
SET MEMORY/SIZE: 25.6 megawords
Peak demand: 81001 words
Current cache: 97201 words
all data in memory:
MYVAR[D=coads_climat]             XY    mr:4 size:16200
1/20E              1/90S           ... / ...          ... /01-JAN 00:45  ... / ...             ... / ...
180/20E(380)        90/90N           ... / ...          ... /01-APR 08:12  ... / ...             ... / ...
 
CONST[ ]                                mr:3 size:1
... / ...          ... / ...          ... / ...          ... / ...          ... / ...             ... / ...
... / ...          ... / ...          ... / ...          ... / ...          ... / ...             ... / ...
 
SST[D=coads_climat]               XY    mr:2 size:32400
1/20E              1/90S           ... / ...          ... /01-JAN 00:45
180/20E(380)        90/90N           ... / ...          ... /01-APR 08:12
AVE
SST[D=coads_climat]               XYT   mr:1 size:48600
1/20E              1/90S           ... / ...             1/01-JAN 00:45
180/20E(380)        90/90N           ... / ...             3/01-APR 08:12

 

SHOW MEMORY/FREE
Summarizes current memory usage.  See Understanding Ferret Memory Management Concepts and Tools for further discussion.

SHOW MEMORY/PERMANENT
Lists the variables cached in memory and cataloged as permanent. These variables will not be deleted even when memory space is needed. They become cataloged in memory as permanent when the LOAD/PERMANENT command is used.

SHOW MEMORY/TEMPORARY
Lists the variables cached in memory and cataloged as temporary (they may be deleted when memory capacity is needed).

SHOW MEMORY/DIAGNOSTIC
Following a memory-intensive command SHOW MEMORY/DIAGNOSTIC can be used to see how the calculation was broken into fragments small enough to fit within the given SET MEMORY/SIZE= limits.  The section See Understanding Ferret Memory Management Concepts and Tools provides in-depth discussion.

The “Last gather” in this example session shows that Ferret split the calculation of T=@AVE into fragments of size 5 points along the T axis in order to fit it into the given memory size of 10 MegaWords.

yes? USE foo.nc
yes? SHOW MODE FRUGAL
MODE            STATE        ARGUMENT
FRUGAL           SET              30
 
yes? SHOW MODE FRUGAL
currently SET data sets:
1> ./foo.nc  (default)
name     title                   I         J         K         L
V        My Variable            1:1000    1:1000    1:1       1:100
 
yes? SET MEMORY/SIZE=10
yes? LOAD V[T=@AVE]
 
yes? SHOW MEMORY/DIAGNOSTIC
Last gather
Variable    Axis   Xform     Chunk    Repeated
V              T     AVE         5           1
Total table slots: 500
Free table slots: 498
Un-cached variables: 0
SET MEMORY/SIZE: 10 megawords
Peak demand: 7 megawords
Current cache: 7 megawords
 
yes? show symbol peak_memory
PEAK_MEMORY = "7000000"

The symbol ($PEAK_MEMORY) is always set; it contains the peak amount of “essential” memory that has been required since the last time this symbol was zeroed by SET MEMORY/SIZE=<size> or CANCEL MEMORY.

Ref Sec33.11.

SHOW MODE

Shows the names, states and arguments of the Ferret SET MODE command.

SHOW MODE [partial_mode_name1,name2,...]

Example:

yes? SHOW MODE VERIFY,META

The qualifier /ALL may be used with this command but exists merely for compatibility reasons and has no effect.

 

Ref Sec33.12.

 

SHOW MOVIE

Shows the current state of SET MOVIE. This state affects FRAME and graphics commands specified with the /FRAME qualifier.

yes? SHOW MOVIE

The qualifier /ALL can be used with this command, but it exists for compatibility purposes only and has no effect.

Ref Sec 33.13

SHOW NCCACHE

Lists the current settings for the NetCDF chunk CACHE. (Ferret v6.6 and higher). The chunk cache size is listed in mbytes. The current default set by the netcdf4.1 library is 4.1943 Mbytes. For more about the role of n_elems and preemption, see the NetCDF documentation

http://www.unidata.ucar.edu/software/netcdf/

 

yes? SHOW NCCACHE
Current NCDF Chunk Cache size 4.1943 MB, n_elems = 1009, preemption = 75

 

 

Ref Sec33.13.

 

SHOW QUERIES

Queries are a vehicle for communication between Ferret and a stand-alone interface program. They are not supported for general use.

 

Ref Sec33.14.

 

SHOW REGION

Shows the current default region or the named region.

yes? SHOW REGION[/ALL] [region_name]

The region displayed is formatted appropriately for the axes of the last data accessed. For example, suppose the region along the Y axis was specified as Y=5S:5N. Then if the Y axis of the last data accessed is in units of degrees-latitude the Y location is shown as Y=5S:5N but if the Y axis of the last data accessed is "ABSTRACT" then the Y location is shown as Y=-5:5.

 

Ref Sec33.15.

 

SHOW SYMBOL

/ALL

Shows the value of one or more symbols (string variables).

yes? SHOW SYMBOL[/qualifier] [symbol_name]

If no qualifier or symbol name is given then all defined symbols are listed. SHOW SYMBOL will accept partial names such as

yes? SHOW SYMBOL *lab*
MY_X_LABEL = "Sample Number"
LABEL_2 = "Station at 23N"

Parameters

The parameter may be the name of a symbol, with * replacing part of the string as above.

Command qualifiers for SHOW SYMBOL:

SHOW SYMBOL/ALL

Lists all symbols that are defined.

 

Ref Sec33...

PyFerret only

SHOW TEXT
Shows the current PyFerret text settings, including any group settings that are different from the main defaults.

yes? set text/font=arial/color=blue
yes? show text
default
/FONT=arial
/COLOR="blue"
/ITALIC=OFF
/BOLD=OFF
/ISIZ= 0
 
yes? ! Now set the colorbar labels to Italic, and the logo in the upper right to a gray color
 
yes? set text/italic cbar
yes? set text/color=(60,60,60) logo
 
yes? show text
default
/FONT=arial
/COLOR="blue"
/ITALIC=OFF
/BOLD=OFF
/ISIZ= 0
LOGO
/COLOR= (60.0,60.0,60.0) (%RGB)
CBAR
/ITALIC=ON
 

 

Ref Sec33.16.

SHOW TRANSFORM

Shows the available transformations, including regridding transformations.

yes? SHOW TRANSFORM

Note: This is the most reliable way to view transformations. The output of this command will be current even when this manual is out of date.

The qualifier /ALL may be used with this command but exists merely for compatibility reasons and has no effect.

 

Ref Sec33.17.

 

SHOW VARIABLES

/ALL /DATASET /DIAGNOSTIC /USER /XML /OUTFILE /APPEND /CLOBBER /TREE

Lists diagnostic or user-defined variables.

SHOW VARIABLES[/qualifier] [partial_name]

Examples:

yes? SHOW VARIABLES  !all user-defined variables 
yes? SHOW VAR/DIAG Q !all diagnostic vars beginning with Q

Command qualifiers for SHOW VARIABLES:

SHOW VARIABLES/ALL
Lists both diagnostic variables (available for the COX/PHILANDER model) and user-defined variables.

SHOW VARIABLES/DATA_SET
Lists variables associated with the named dataset by DEFINE VARIABLE/DATA_SET=

SHOW VARIABLES/DIAGNOSTIC
This is an unsupported (obsolete) qualifier. It lists "diagnostic" variables available for the COX/PHILANDER model.

SHOW VARIABLES/USER
Lists expressions that have been defined by the user as new variables. This is the default behavior of SHOW VARIABLES with no qualifier.

SHOW VARIABLES/XML /OUTFILE=filename.xml /APPEND /CLOBBER
List the variable for all currently defined user-defined variables in XML-style. /OUTFILE /APPEND, and /CLOBBER allow for this to be written to a file.

SHOW VARIABLE/TREE [=ALL] [=FILE] [=USER (default)] [expression1, expr2, expr3, ...]
alias VTREE

Lists variables in the form of a "tree" in order to show the inter-dependencies of the variables. By default only user-defined ("LET") variables will be displayed. The /TREE=ALL option will include the file variables that must be accessed in order to compute the variable at the top of the tree. The /TREE=FILE will provide a simple list, without tree formatting, of only the file variables upon which the tree depends.

The SHOW VARIABLE/TREE command (hereafter referred to by its command alias, VTREE) will show the tree of dependencies even in cases where the variable is not computable due to the following factors: unknown variable names, unknown dataset names or numbers, erroneous definitions due to recursive definitions or syntax errors. If any of these errors are encountered in the variable tree then the offending variable name is displayed in its proper place in the tree together with a let comment explaining the nature of the problem

The inter-connectedness of variables in a tree depends upon the current default dataset. The current default dataset can be specified through the SET DATA command or through the /DATA_SET= qualifier. For example, suppose that dataset file1.nc contains a variable named V but dataset file2.nc does not. If the variable Vp1 is defined by "LET Vp1 = V + 1", then VTREE=ALL/DATA_SET=file1 Vp1 will show V as a file variable, whereas the same command with /DATA_SET=file2 will show V as an unknown variable name.

When VTREE is asked to display multiple trees it will show them in order of largest tree to smallest. If the definition of a variable is displayed as part of a larger tree, it will not be displayed again as a separate variable. If the VTREE command is given with no argument it will display all of the LET variables known in the default dataset. If the VTREE command is given with multiple arguments it will process all of the given arguments as a group and attempt to minimize duplication.

Here is an example illustrating the VTREE output

yes? go polytube_demo
.
.
.
yes? VTREE xtrack
XTRACK = IF L LE 70 THEN XSTRAIGHT ELSE XLEG3
XSTRAIGHT = IF L LE 50 THEN XLEG1 ELSE XLEG2
XLEG1 = X0 + (L-1)*(X1-X0)/50
X0 = 240
X1 = 180
XLEG2 = X1 + (L-51)*(X2-X1)/20
X1 =  (defined above)
X2 = 150
XLEG3 = X2+R0 - RADIUS * COS(LCURVE/12)
X2 =  (defined above)
R0 = 35
RADIUS = R0 - LCURVE/3
R0 =  (defined above)
LCURVE = L-71
LCURVE =  (defined above)
 

 

If variables or datasets that the variable depends upon are not available, VTREE will report those dependencies. Continuing the example above; if a variable hasn't been define:

 

yes? cancel variable xleg2
yes? Vtree xtrack
XTRACK = IF L LE 70 THEN XSTRAIGHT ELSE XLEG3
XSTRAIGHT = IF L LE 50 THEN XLEG1 ELSE XLEG2
XLEG1 = X0 + (L-1)*(X1-X0)/50
X0 = 240
X1 = 180
XLEG2 ??                 <== UNKNOWN VARIABLE ******
XLEG3 = X2+R0 - RADIUS * COS(LCURVE/12)
X2 = 150
R0 = 35
RADIUS = R0 - LCURVE/3
R0 =  (defined above)
LCURVE = L-71
LCURVE =  (defined above)

Regridding dependencies are reported as well.
 

yes? use coads_climatology
yes? use levitus_climatology
yes? let c = temp[gz=sst[d=1], z=0] + sst[d=1,gy=a,t=@ave]
 
yes? show var/tree=all c
in default dataset levitus_climatology
C = TEMP[GZ=SST[D=1], Z=0] + SST[D=1,GY=A,T=@AVE]
TEMP
regrid to SST[d=coads_climatology]
SST[d=coads_climatology]
regrid to A ??           <== UNKNOWN GRID ******
 
 
yes? let d = temp + sst[d=1,gx=un]
yes? show var/tree=all d
in default dataset levitus_climatology
D = TEMP + SST[D=1,GX=UN]
TEMP
SST[d=coads_climatology]
regrid to UN ??          <== UNKNOWN GRID ******
 
yes? cancel data 2
yes? show var/tree=all d
in default dataset coads_climatology
D = TEMP + SST[D=1,GX=UN]
TEMP ??                    <== UNKNOWN VARIABLE ******
SST
regrid to UN ??          <== UNKNOWN GRID ******
 

 

Ref Sec33.18.

 

SHOW VIEWPORT

Shows one or more of the currently defined viewports. Omitting an argument gives information on all viewports.

yes? SHOW VIEWPORT [view_name1,view_name2,...]

Example:

yes? DEFINE VIEWPORT/AXES/XLIM=0:0.5/YLIM=0.3:0.8 leftmid 
yes? SHOW VIEWPORT left*
 
name    text   xlimits   ylimits       mode
LEFT    1.00   0.00,0.50   0.00,1.00   edges
LEFTMID 0.50   0.00,0.50   0.30,0.80   axes 
 
current viewport is NONE

This command shows the pre-defined viewport LEFT, and our user-defined viewport named LEFTMID. Under Column 1, text, is the setting for scaling the size of text. The xlimits and ylimits columns list the edges of the viewport. Mode takes the value edges for the default setting where the viewport limits include space for margins around the plot axes, or axes if the viewport was defined with the /axes qualifier, indicating that the limits define the location of the plot axes.

The qualifier /ALL may be used with this command but exists merely for compatibility reasons and has no effect.

 

Ref Sec33.19.

 

SHOW WINDOW

Lists open window numbers and indicates which is the active one.

yes? SHOW WINDOWS

The qualifier /ALL may be used with this command but exists merely for compatibility reasons and has no effect.

 

In PyFerret, the SHOW WINDOW command displays additional values that are options for the SET WINDOW command in PyFerret. For example:

yes? show window
OPEN  ACTIVE  ANTIALIAS  QUALITY  DISPLAY  THICKEN  TEXTPROM
1      *       YES       HIGH     YES      1.00     1.00