Panfish
=======

NAME
  Panfish - Multicluster job submission

SYNOPSIS

  # stages data
  panfishchum --path /home/foo -q myshadow.q

  # submits a job
  panfishcast -q myshadow.q myjob.sh
  
  # check status using Open Grid Engine command
  qstat ... 
  
  # retreives data 
  panfishland --path /home/foo -q myshadow.q


DESCRIPTION

  Panfish is a tool that enables Open Grid Engine serial jobs to be run 
  on remote clusters.

  In a standard usage scenario the user first uploads data to the 
  remote clusters via panfishchum.  The user then invokes a Panfish 
  command panfishcast to submit their jobs.  The user then monitors 
  the jobs via the id returned by the submission command using the qsub
  command.  Upon job completion the user invokes panfishland to 
  retrieve the data.  

  Run "perldoc Panfish" while in source directory before installation
  for more documentation or visit:
  https://github.com/CRBS/Panfish/wiki


DEPENDENCIES

  * Linux (tested Centos 6)
  * Perl 5.10+
  * Bash 4+
  * Ssh 5+
  * Rsync 3+
  * Open Grid Engine or Sun Grid Engine 6.1+


INSTALLATION

  To install this module type the following:

     # For alternate install location use PREFIX= on perl Makefile.PL
     # command below

     perl Makefile.PL  
     make 
     make test
     make install
 
  Visit https://github.com/CRBS/Panfish/wiki
  for setup instructions.


COPYRIGHT AND LICENCE

Copyright 2013 The Regents of the University of California All Rights Reserved

Permission to copy, modify and distribute any part of this Panfish for educational, research and non-profit purposes, without fee, and without a written agreement is hereby granted, provided that the above copyright notice, this paragraph and the following three paragraphs appear in all copies.

Those desiring to incorporate this Panfish into commercial products or use for commercial purposes should contact the Technology Transfer Office, University of California, San Diego, 9500 Gilman Drive, Mail Code 0910, La Jolla, CA 92093-0910, Ph: (858) 534-5815, FAX: (858) 534-7345, E-MAIL:[email protected].

IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS Panfish, EVEN IF THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

THE Panfish PROVIDED HEREIN IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. THE UNIVERSITY OF CALIFORNIA MAKES NO REPRESENTATIONS AND EXTENDS NO WARRANTIES OF ANY KIND, EITHER IMPLIED OR EXPRESS, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, OR THAT THE USE OF THE Panfish WILL NOT INFRINGE ANY PATENT, TRADEMARK OR OTHER RIGHTS.