Differences

This shows you the differences between two versions of the page.

--- supportsci:tools [2019/04/03 11:59] – [Pipe (jop83)] benito
+++ supportsci:tools [2019/04/08 11:58] (current) – [EEE(2)] benito
@@ Line 204: / Line 204: @@
 </code>
+**pipelet.py** - Parses the pipe letter (exp.pipelet) to be sent to the PI after pipelining the data.
+<code>
+usage: pipelet.py [-h] [-v] [-o OUTPUT] [-c CREDENTIALS] [-u USERNAME] [-p PASSWORD]
+                   experiment jss
+Creates a .pipelet file in the current directory. This letter is the content that must
+be sent to the PI after pipelining an experiment. It contains information about the
+pipeline output and the credentials to access the data.
+It takes the credentials from the username_password.auth file that should be placed in
+the current directory (otherwise specify its file, or the username and password as parameters).
+The user must provide the following information:
+- The experiment name (case insensitive).
+- Who are you (the Support Scientist). Type your surname.
+positional arguments:
+  experiment            Experiment name.
+  jss                   JIVE Support Scientist doing the post-processing (your surname).
+optional arguments:
+  -h, --help            show this help message and exit
+  -v, --version         show program's version number and exit
+  -o OUTPUT, --output OUTPUT
+                        Output directory where the file {experiment}.pipelet will be store
+                        (by default the current directory)
+  -c CREDENTIALS, --credentials CREDENTIALS
+                        Auth file containing the username and password in its name (required
+                        if *.auth is not in current directory).
+  -u USERNAME, --username USERNAME
+                        Username to access the data (required if no credential file exists)
+  -p PASSWORD, --password PASSWORD
+                        Password to access the data (required if no credential file exists)
+</code>
 =====Pipe (jop83)=====
@@ Line 307: / Line 341: @@
 **uvflgall.csh** - makes a uvflgfs file from any .log files in the current directory. Also changes flagr line to make uvflg.pl happier.
-**comment_file.py** - tool to create the comment file to be located in the pipeline output before running the feedback.pl script (and after having run the pipeline):
+**comment_tasav_file.py** - tool to create the comment file to be located in the pipeline output before running the feedback.pl script (and after having run the pipeline):
 <code>
-usage: comment_file.py [-h] [-o OUTPUT] [-v] experiment
+usage: comment_tasav_file.py [-h] [-v] [-oc OUTPUT_COMMENT] [-ot OUTPUT_TASAV]
+                       experiment
-Creates a .comment file for the EVN Pipeline. Given a default template,
+Creates a .comment file (in $OUT/exp directory) and a .tasav.txt file (in
-customizes it to include the basic data from the given experiment. The script
+$IN/exp). Given the default templates, it customizes them to include the basic
-will ask you in the terminal about all the required inputs.
+data from the given experiment. The script takes the information from
+different locations (ccsbeta, pipe $IN and $OUT directories). The EVN Pipeline
+must have been run before calling this script.
 positional arguments:
@@ Line 322: / Line 359: @@
 optional arguments:
   -h, --help            show this help message and exit
-  -o OUTPUT, --output OUTPUT
-                        Output directory where the file {experiment}.comment
-                        will be saved (by default in
-                        /jop83_0/pipe/out/{experiment})
   -v, --version         show program's version number and exit
+  -oc OUTPUT_COMMENT, --output_comment OUTPUT_COMMENT
+                        Output directory where the file {experiment}.comment
+                        will be saved (by default in $OUT/{experiment})
+  -ot OUTPUT_TASAV, --output_tasav OUTPUT_TASAV
+                        Output directory where the file {experiment}.tasav.txt
+                        will be saved (by default in $IN/{experiment})
 </code>
 All additional data are taken from different files: the script access ccsbeta to get the epoch of the observation (from the MASTER_PROJECT.LIS file), and it also reads the pipeline input file and the pipeline output .SCAN and .DTSUM files. The default output will be in $OUT/{exp}/{exp}.comment, unless other location is indicated by the -o option.