GSFITCP Help: Difference between revisions

From EOVSA Wiki
Jump to navigation Jump to search
Line 8: Line 8:
=Launching the GSFITCP command prompt application=
=Launching the GSFITCP command prompt application=


GSFITCP is launched using the following call:
To obtain a list of valid GSFIT calling sequences one may call'''''gsfitcp''''' with no arguments:
<pre>
</pre>
IDL> gsfitcp, taskfile[, nthreads, start=start, quiet=quiet]
IDL> gsfitcp
% GSFITCP: For a detailed description visit http://www.ovsa.njit.edu/wiki/index.php/GSFITCP_Help, or use one of the folowing calling sequences:
% IDL-> gsfitcp, taskfilename; to provide a path to a stored GSFIT task stracture
% IDL-> gsfitcp, taskstructure; to provide an already restored GSFIT task structure
% IDL-> gsfitcp, nthreads; to set,increase, or decrease the number of ashyncronious threads to be used
% IDL-> gsfitcp, out=out,log; to change the default "gsfitcp.log" path for run-time logging of the results.
% IDL-> gsfitcp, /status; to report the status of the application
% IDL-> gsfitcp, /quiet; to inhibit automatic printing of progress report messages at run-time
% IDL-> gsfitcp, /start; to start processing the task queue
% IDL-> gsfitcp, /flush; to flush the pending task queue
% IDL-> gsfitcp, /abort; to abort all active tasks and flush the pending task queue
% IDL-> gsfitcp, /exit; to abort all active tasks, flush the pending task queue, and exit the apllication
% IDL-> gsfitcp,taskfilename,/start; This minimal call sequence should get you started on one thread!
</pre>
</pre>
where
*'''''taskfile''''' is a mandatory string argument indication the path to a file in which a GSFIT task has been previously saved, as explained in the [[GSFIT Help]] page. Alternatively, the string argument '''''taskfile''''' may be replaced by an IDL task structure that has ben previously restored from such a task file.
*'''''nthreads''''' is an optional argument indicating the number of parallel asynchronous threads to be used
*'''''/start''''' is an optinal keyword that, if set, requests immediate start of the batch processing
*'''''/quiet''''' is an optional keyword that, if set, prevents GSFITCP to print periodic run-time messages reporting the progress of the fitting process.
A detailed description of the GSFITCP functionality is provided below.

Revision as of 15:41, 14 May 2019

GSFITCP is the command prompt counterpart of the GSFIT GUI microwave spectral fitting application. Once started, GSFITCP is designed to run in unattended mode until all fitting tasks assigned to it are completed and log on the disk in an user-defined *.log file, the content of which may be visualized using the GSFITVIEW GUI application. When run remotely on an Linux/Mac platform, the GSFITCP may be launched on a detached screen, which allows the remote user to logout without stopping the process in which GSFITCP runs.

GSFITCP Installation

GSFITCP is part of the GSFIT IDL Package

To get installation instructions for the IDL GSFIT package, please visit the GSFIT Installation page.

Launching the GSFITCP command prompt application

To obtain a list of valid GSFIT calling sequences one may callgsfitcp with no arguments:

IDL> gsfitcp % GSFITCP: For a detailed description visit http://www.ovsa.njit.edu/wiki/index.php/GSFITCP_Help, or use one of the folowing calling sequences: % IDL-> gsfitcp, taskfilename; to provide a path to a stored GSFIT task stracture % IDL-> gsfitcp, taskstructure; to provide an already restored GSFIT task structure % IDL-> gsfitcp, nthreads; to set,increase, or decrease the number of ashyncronious threads to be used % IDL-> gsfitcp, out=out,log; to change the default "gsfitcp.log" path for run-time logging of the results. % IDL-> gsfitcp, /status; to report the status of the application % IDL-> gsfitcp, /quiet; to inhibit automatic printing of progress report messages at run-time % IDL-> gsfitcp, /start; to start processing the task queue % IDL-> gsfitcp, /flush; to flush the pending task queue % IDL-> gsfitcp, /abort; to abort all active tasks and flush the pending task queue % IDL-> gsfitcp, /exit; to abort all active tasks, flush the pending task queue, and exit the apllication % IDL-> gsfitcp,taskfilename,/start; This minimal call sequence should get you started on one thread!