The Lw2ILwd User Command (Meta Macro)

All user commands have the form:

ldasJob { -name {} -password {} -email {} } { userCmd -opt1 {} ... }

Which is in the format of a Tcl command, ldasJob, with two required arguments:

1. A Tcl list of user information consisting of username, password, and e-mail address. All fields must be filled or the command will be rejected.
   Client software which would like to receive responses from the LDAS system on a port instead of through email can provide a hostname:port combination as the email argument. A further feature of this method is that the hostname can be replaced with the magic key !host!, and the LDAS system will use the IP address it finds by doing a peername lookup on the connected socket.
2. A user command in the form of a Tcl list, for which there exists a "meta" macro file which can be expanded into Tcl code which can then be evaluated by the LDAS system.
   An argument must be provided to every option field for any given command or the command will be rejected.
   Some option fields will accept a "null" argument consisting of a matching pair of braces "{}" with no interposed space.
   Meta macros consist of a prototype declaration of the arguments for the given user command, and a template describing the calling order of API specific blocks of Tcl code which are concatenated into a larger block comprising the complete request, which can then be distributed by the assistant manager for interpretation by the low level API's.
   These API specific blocks are maintained as API specific macro files consisting of immediately interpretable Tcl code.

• Lw2ILwd

• Lw2ILwd

  Given a valid url for a LIGO_LW, converts the LIGO_LW document to ilwd
  

  Calling convention (all on a single line):

  ldasJob   { -name   "username"   -password   "********"   -email   "user@foobar.edu"}   {Lw2ILwd   -ingestdata   URL  -returnprotocol   URL  -ingestdataapi   URL  -outputformat   {ilwd ascii | ilwd binary}  -subject   {freeform string}  }

  Option Descriptions:

  -ingestdata:     http ftp file

  The argument of the -ingestdata option URL format is of the format similar to that of -returnprotocol. The URL specifies the source of of the data to be ingested in xml format. A file extension of ".xml" is required to identify a LIGO_LW file; The URL must be valid for the command to be successfully executed.
  • http://filename.ext

  • ftp://filename.ext

  • file:/filename.ext

    NOTES:

    1. Embedded spaces in the argument to the -ingestdata option will cause the request to fail.

  -ingestdataapi:     api

  Optional: only needed when requesting ilwd to be sent to an api for processing, e.g. use within the putMetaData command.
  The argument of the -ingestdataapi option the api to send the ilwd converted from the LIGO_LW document. Default: {}
  

  -subject:  {subject for the return e-mail}

  Default: "jobID completed"
  String to be used as the subject for the e-mail returned by the system on completion of the job.

  Examples of Lw2ILwd commands:

  Examples on how to use this command

  This example presents a Tcl script which can be run from any computer with a network connection to submit a user command to the LDAS system:

  #!/bin/sh
  # use -*-Tcl-*- \
  exec tclsh "$0" "$@"
  
  # convenient formatted command definition
  set cmd "ldasJob
     { -name foo -password **** -email foo@foobar.edu }
     {
        Lw2ILwd
           # subject to be used when e-mailing user
           -subject {test script for Lw2ILwd}
           
           # input url for converting 
           -ingestdata file:/ldas_usr/ldas/test/database/TrigMgr20010307234636000002010000.xml 
           
           # ilwd format for output ilwd (optional) 
           -outputformat {ilwd ascii}
           
           # returnprotocol has the name of output file, directory structure is ignored.
           -returnprotocol file:TrigMgr20010307234636000002010000.ilwd        
     }"
  
  # strip comments and compact cmd into user command format
  set cmd [ split $cmd "\n" ]
  foreach line $cmd {
     set line [ string trim $line ]
     if { [ regexp {^#} $line ] } {
        continue
     }
     lappend tmp $line
  }   
  set cmd [ join $tmp "\n" ]
  regsub -all -- {[\n\s]+} $cmd { } cmd
  
  # connect, issue command, print reply from manager,
  # and disconnect
  set sid [ socket ldas-dev.ligo.caltech.edu 10001 ]
  puts  $sid $cmd
  flush $sid
  puts [ read $sid ]
  close $sid
  

  Which submits this command to the system:
  • ldasJob  {  -name  "foo"  -password  "****"  -email  "foo@foobar.edu" }  { Lw2ILwd  -subject  {test script for Lw2ILwd}  -ingestdata  file:/ldas_usr/ldas/test/database/TrigMgr20010307234636000002010000.xml  -outputformat  {ilwd ascii}  -returnprotocol  file:TrigMgr20010307234636000002010000.ilwd   }

    Output created by ligolw API in ilwd ascii format in the job output directory: TrigMgr20010307234636000002010000.ilwd

    Return to Top