Running Configured Pipelines within ASSIST

I. Objective

The pre-configured pipelines can be run from within the Release 1 Graphical Navigator, ASSIST. The user can supply the input data set and the value of some key parameters.

II. Execution

1. From an ASCDS window, bring up assist:

   : run_assist

   You will see an ASSIST GUI and an "ASCshell" window. The ASCshell window is a normal unix shell and can be used to run any ASCDS tools or pipelines via the command line.



2. In the ASCshell window, cd to the directory you wish to use for processing.

   : mkdir pipe1
   : cd pipe1
   

3. Get to the Configured Pipeline nodes. In the ASSIST GUI:
   
   
   • hit the "Top View" button
   • hit the "Science Operations Staff ..." button
   • hit the "___ Configured Pipelines ..." button


4. Run the Pipeline of your choice, for example:
   
   
   • hit the "acis_L1" button
   
   The task will run in the ASCshell window. It may take a few seconds for the task to be initiated. Two parameter file editor windows will be brought up. To edit parameters, move the cursor under the "value:" column for each row and enter the values. A description of each parameter can be found under the "prompt:" column. You do not need to fill in the "min:" or "max:" columns. Hit return when done with each value. When done entering data, hit "Update", then "Close".

   The first parameter file to be edited handles the runtime parameters. The defaults are set to run the pipelines with sample data which can be found in the ~ascds/gen directory. To run these sample pipelines the user must only edit the "nameroot" parameter, "acistest" for an ACIS pipeline and "hrctest" for an HRC pipeline. See the writeups for each of the individual pipelines for more details on the input and output data.

   If the "dispdata" parameter is set to "yes", the results of each configured pipeline will automatically be displayed.

   Another parameter file editor will be brought up to allow you to edit some general pipeline parameters. You may run with the defaults if you wish (just hit "Close"). See the writeup for the Pipeline Parameters for more details.

5. When the Pipeline is finished you will find the results in the three directories specified in the runtime parameter file:

   outdata - contains the output data generated

   logfile - contains a log of the pipeline processing

   profile - contains the profile generated to run the chosen pipeline with the specified input data



6. If you have selected the automatic display option ("dispdata=yes"), then the following table gives you a little idea of what you can expect to see in terms of data, and what to do about it.

   			   ACIS
   
      Pipe			Output Form		How to Exit
   -----------------------------------------------------------------------
      L1			xterm window (bad)      use right mouse button
   			                        to click on title bar 
   			                        and select "Quit"       
   			SAOtng display (fnt)    Hit "exit" under the
   						"File" pulldown menu
   
      Spectral		xterm window		use right mouse button
      Resolution					to click on title bar 
   						and select "Quit"       
      			
      Charge      		xterm window            use right mouse button
      Transfer    		                        to click on title bar 
      Inefficiency		                        and select "Quit"        
   
      Spectral		xterm window		use right mouse button
      Resolution					to click on title bar 
      &						and select "Quit"       
      Charge      		
      Transfer    
      Inefficiency
   
      Detector Image	SAOtng display (binary) Hit "exit" under the
   						"File" pulldown menu
   			SAOtng display (total)  Hit "exit" under the
   						"File" pulldown menu
   
      Light Curve		PGPLOT (light-curves)   type 'quit' on ASCShell
   			PGPLOT (gti)		type 'quit' on ASCShell
   			
      Pulse		PGPLOT (g-split_c0)     type 'quit' on ASCShell
      Height		PGPLOT (g-split_c1)	type 'quit' on ASCShell
      Distribution		PGPLOT (g-split_c2)	type 'quit' on ASCShell
   			PGPLOT (g-split_c3)	type 'quit' on ASCShell
   			PGPLOT (g-combine_c0)	type 'quit' on ASCShell
   			PGPLOT (g-combine_c1)	type 'quit' on ASCShell
   			PGPLOT (g-combine_c2)	type 'quit' on ASCShell
   			PGPLOT (g-combine_c3)	type 'quit' on ASCShell
   
      Readnoise		PGPLOT (im)		type 'quit' on ASCShell
   			PGPLOT (oc)		type 'quit' on ASCShell
   
   
   
   			    HRC
   
      Pipe			Output Form		How to Exit
   -------------------------------------------------------------------
      L01			SAOtng                  Hit "exit" under the
      			                        "File" pulldown menu
      			                        
   
      Background		xterm window            use right mouse button
      vs			                        to click on title bar 
      Pulse Height		                        and select "Quit"       	
   		        histogram		use right mouse button
   						to click on title bar 
   						and select "Quit"       
   
      Background		SAOtng(bkg)             use right mouse button
      vs			                        to click on title bar 
      Position		                        and select exit       
   
      Count Rate		xterm window            use right mouse button
      Linearity		                        to click on title bar 
     			                        and select "Quit"       
   
      Gain 		xterm window            use right mouse button
      vs			                        to click on title bar 
      Position		                        and select "Quit"       
   
      HotBad		SAOtng (hot)            Hit "exit" under the
   			                        "File" pulldown menu
   			SAOtng (bad)            Hit "exit" under the
   			                        "File" pulldown menu
      Quantum		SAOtng (qe)             Hit "exit" under the
      Efficiency		                        "File" pulldown menu
   
      Spatial		xterm window            use right mouse button
      Linearity		                        to click on title bar
   			                        and select "Quit"      
   
      Spatial 		none			does not currently 
      Resolution					display any output 
   						data.
   			 
      UV Ion Shield	SAOtng (def)            Hit "exit" under the
   			                       "File" pulldown menu
   			SAOtng (uef)            Hit "exit" under the
   			                       "File" pulldown menu
   

7. From the "Configured Pipelines" window you may select the "display only" feature for any of the pipelines. This brings up a parameter file in a pop-up window allowing the user to enter the root name of the data file (e.g., "hrctest_evt.qp" would be entered as "hrctest"), the name of the directory holding the pre-processed data, and the name of the directory to which you want you display files to be written. This allows the user to examine data that was produced by previously running the pipeline. This includes files not generated by the user (i.e., if someone else has already run the pipeline and you wish to merely view their results without re-running it). The files generated by executing this node, however, should be written to the user's space.