HMI Ring Diagrams Pipeline Script Specifications

Script Version
	2.6	22 IX 2020

General Description
	Implements the synoptic ring-diagrams pipeline for “daily” analysis of
	local regions on three different scales, 5°, 15°, and 30°

Status
	Iincluded in  in JSOC release 9.41
	In use for ring-diagram pipelines from 2020.09.22
	This version supersedes Version 2.5

	The script is in the JSOC CVS repository

Usage
	rdday [-test]  SIZE CR CL [N]
	
	Auxiliary script names rdday_psp, rdday_qfit, rdday_inv, and rdday_cfit
	are aliases used to (re-)start processing at successive steps beyond tracking.
	
Arguments
	-test		If specified, the input and output series will be in namespace
			hmi_test by default; otherwise they are in hmi. Also if specified,
			options for non-standard module versions or modules and input series
			namespaces will be read from a specified file

	SIZE		The tile size to be analyzed: must be 5, 15, or 30

	CR		The Carrington rotation number at the center of the analysis interval

	CL		The central meridian longitude at the center of the analysis interval

	N		If specified, tracking will start with set N rather than 0; only used
			for resumption of interrupted processing of 5° of 15° tiles (only one
			set of 30° tiles is produced)

Input Data Series/Records:
    		normal			test
	hmi.V_45s		hmi_test.V_45s
	hmi.M_45s		hmi_test.M_45s
	hmi.V_avg120		hmi_test.V_avg120
	yale_cb.guess_table[1]	yale_cb.guess_table[1]

Intermediate and Output Data Series:
    		5°			15°			30°
	hmi.rdMAI_fd05		hmi.rdmai_fd15		hmi.rdmai_fd30
	hmi.rdVtrack_fd05	hmi.rdVtrack_fd15	hmi.rdVtrack_fd30
	hmi.rdVpspec_fd05	hmi.rdVpspec_fd15	hmi.rdVpspec_fd30
				hmi.rdVfitsf_fd15	hmi.rdVfitsf_fd30
	hmi.rdVfitsc_fd05	hmi.rdVfitsc_fd15	hmi.rdVfitsc_fd30
				hmi.rdVflows_fd15_frame	hmi.rdVflows_fd30_frame

	(in test mode, same products in namespace hmi_test)

Modules invoked:
	rdcover
	gentargs
	maicalc
	mtrack
	pspec3
	rdfitf
	rdfitc
	rdvinv

	(in test mode particular versions of modules, or other modules entirely,
	may be used as requested, provided calling sequences are compatible)

Auxiliary Scripts invoked:
	~rick/hmi/pikewatch

Auxiliary Files used:
	~rick/hmi/notify (for addresses of email notifications)
	~rick/hmi/rings/testoptions (for test options if -test specified)
		if not present, both default to /tmp
	~rick/hmi/tmpfs (optional locations for roots of temp and scratch directories)
	~rick/hmi/ (optional alternative base for temp and scratch directories)
	/home/dhaber/coefhrtest.dat (required for rdfitf)
	~rick/hmi/pike (fulfills required argument to ~rick/hmi/pikewatch)

Auxiliary Scripts invoked if present:
	~rick/bin/tmplocs

Fixed Parameter Values:

Default Parameter Values (Fixed for non-Test mode):

Sample commands:
	rdday 30 2100 180
	rdday -test 15 2100 195
	rdday 5 2100 200 4

Changes from Previous Version
	— removed non-default value for argument tobs_key to module mtrack

Bugs in current version
	The intermediate input series cannot be overridden by the options file in
	continuation runs in test mode.

	When the script is aborted early on account of missing series or modules,
	notification is only to stdout; there is no mailed or logged report.

	Uses current default values to module rdcover for arguments trec_key, tobs_key,
	tstp_key, qual_key, clon_key, clat_key, crot_key, and pa_key.

	Uses current default values to module maicalc for arguments rec_step, mask_ex,
	trec_key, tobs_key, tstp_key, qual_key, clon_key, clat_key, crot_key, rsun_key,
	apsd_key, and dsun_key.

	Uses current default values to module mtrack for arguments interp, fillopt,
	map_pa, merid_v, trec_key, tobs_key, tstp_key, qual_key, clon_key, clat_key, crot_key,
	rsun_key, apsd_key, dsun_key, cvkey, cvok, and cvno.

	Uses current default value to module pspec3 for argument copy.

	Uses current default values to module rdfitf for arguments guessfile, nmin,
	npar, ntht, nthts, nrdtot, ux, uy, smooth, mdata, mfilt, xtol, ftol, feps,
	delta0, maxeval, igrad, iextrap, idiag, and iprint.

	Uses current default values to module rdfitc for argument copy.

HMI Ring Diagrams

5 Nov 2021, 14:12-0700