Difference between revisions of "Extracting scripts from these tutorials"

From CASA Guides
Jump to: navigation, search
(Version Notes)
Line 1: Line 1:
The series of commands shown in each tutorial can be thought of as a data reduction script that can be run in CASA like so:
+
The series of commands shown in each tutorial can be written to a single casapy script using the CASA Guides script extractor.  The script extractor is described here.
  
<pre>
+
__TOC__
execfile('scriptname.py')
 
</pre>
 
 
 
where 'scriptname.py' is the name of an ascii file containing all of the CASA commands you want to run.
 
 
 
Hopefully the scripts contained in this documentation are (a) useful and (b) work. They were however developed with CASA still a work in progress, and so scripts may break as commands, arguments, and keywords change. We developed this script extractor to allow us to easily extract scripts from these pages and run them. Feel free to try it--it's handy for general users too!
 
 
 
The only differences you will see between the commands in each tutorial and the extracted script are requests for response from you after each interactive  command (plotants, plotcal, plotms, etc.).  These are to ensure that the tables you access to make plots are closed properly before they are needed by some following task (otherwise, you may experience the dreaded "table lock" errors, that may cause problems with your script, or in some cases even your CASA session.)
 
  
<div style="background-color: #dddddd;">
+
== Introduction ==
'''Note:''' the intention is to extract CASA scripts for testing; commands which are to be run on the command line outside of CASA, or within other software packages, will not be extracted.
 
</div>
 
  
 
+
The script extractor will produce a Python script that can be invoked inside casapy.  The extractor ignores all CASA Guide source code that is not Python.  Special UNIX commands (such as 'ls' and 'less') supported by casapy but not by Python are commented out, and interactive pauses are inserted when GUIs are invoked.  (The interactive pause is necessary to avoid table lock errors that are produced when multiple tasks are run simultaneously.)
 
 
__TOC__
 
  
 
== How to Get the Script Extractor ==
 
== How to Get the Script Extractor ==
Line 26: Line 14:
 
This Python module is maintained in a github repository as part of a simple, automated benchmark testing system.  You can browse the whole repository at https://github.com/jaredcrossley/CASA-Guides-Script-Extractor.
 
This Python module is maintained in a github repository as part of a simple, automated benchmark testing system.  You can browse the whole repository at https://github.com/jaredcrossley/CASA-Guides-Script-Extractor.
  
The older, pre-github version of the script extractor can be obtianed from ftp://ftp.cv.nrao.edu:/NRAO-staff/jgallimo/extractCASAscript.py.
+
''The older, pre-github version of the script extractor can be obtianed from ftp://ftp.cv.nrao.edu:/NRAO-staff/jgallimo/extractCASAscript.py.''
  
 
== How to Use the Script Extractor ==
 
== How to Use the Script Extractor ==
  
Make your newly acquired python script executable.
+
Make your newly acquired Python script executable.
  
 
<source lang="bash">
 
<source lang="bash">
Line 37: Line 25:
 
</source>
 
</source>
  
To run it, issue the python script name and give the URL as the argument. For example:
+
To run it, issue the Python script name and give the URL as the argument. For example:
  
 
<source lang="bash">
 
<source lang="bash">
Line 51: Line 39:
 
</source>
 
</source>
  
This command will automatically generate a script called <tt>CalibratingaVLA5GHzcontinuumsurvey.py</tt>.
+
This command will automatically generate a script called <tt>CalibratingaVLA5GHzcontinuumsurvey.py</tt>.  This script can be run in casapy:
 +
 
 +
<source lang="python">
 +
# in CASA
 +
execfile('CalibratingaVLA5GHzcontinuumsurvey.py')
 +
</source>
 +
 
 +
== Support ==
 +
 
 +
Questions and bug reports should be submitted to either the [https://help.nrao.edu/ NRAO] or [https://help.almascience.org/ ALMA] helpdesks.

Revision as of 11:18, 30 May 2012

The series of commands shown in each tutorial can be written to a single casapy script using the CASA Guides script extractor. The script extractor is described here.

Introduction

The script extractor will produce a Python script that can be invoked inside casapy. The extractor ignores all CASA Guide source code that is not Python. Special UNIX commands (such as 'ls' and 'less') supported by casapy but not by Python are commented out, and interactive pauses are inserted when GUIs are invoked. (The interactive pause is necessary to avoid table lock errors that are produced when multiple tasks are run simultaneously.)

How to Get the Script Extractor

For most uses, the single-module script extractor is all you will need. You can download it from https://raw.github.com/jaredcrossley/CASA-Guides-Script-Extractor/master/extractCASAscript.py.

This Python module is maintained in a github repository as part of a simple, automated benchmark testing system. You can browse the whole repository at https://github.com/jaredcrossley/CASA-Guides-Script-Extractor.

The older, pre-github version of the script extractor can be obtianed from ftp://ftp.cv.nrao.edu:/NRAO-staff/jgallimo/extractCASAscript.py.

How to Use the Script Extractor

Make your newly acquired Python script executable.

# in bash
chmod u+x extractCASAscript.py

To run it, issue the Python script name and give the URL as the argument. For example:

# in bash
./extractCASAscript.py http://casaguides.nrao.edu/index.php?title=Calibrating_a_VLA_5_GHz_continuum_survey

In csh, you need quotes around the URL:

# in csh
./extractCASAscript.py 'http://casaguides.nrao.edu/index.php?title=Calibrating_a_VLA_5_GHz_continuum_survey'

This command will automatically generate a script called CalibratingaVLA5GHzcontinuumsurvey.py. This script can be run in casapy:

# in CASA
execfile('CalibratingaVLA5GHzcontinuumsurvey.py')

Support

Questions and bug reports should be submitted to either the NRAO or ALMA helpdesks.