fermitools / rgang Goto Github PK

                                 R E A D M E


Product Name:           rgang
Product Version:        3.9.2
Date (yyyy.mm.dd):      2023.08.05

------------------------------------------------------------------------

                                   ORIGIN
                                   ======
Author

    Ron Rechenmacher

    Fermi National Accelerator Laboratory - Mail Station 234
    P.O Box 500
    Batavia, IL 60510
    Internet: [email protected]

Fermilab Standard Government Sponsorship Notice

    This work was performed at Fermi National Accelerator Laboratory,
    which is operated by Universities Research Association, Inc., under
    contract DE-AC02-76CHO3000 with the U.S. Department of Energy.

Acknowledgements

    The name "rgang" and the original shell versions came from Marc Mengel;
    Kurt Ruthmansdorfer added to and modified the original versions; Jon
    Bakken added "copy mode"; and Ron Rechenmacher added the "nway" (including
    parallel execution) "tree structure" concepts.


------------------------------------------------------------------------

                             TERMS AND CONDITIONS
                             ====================

This software has been made freely available with a request for
collaborative input subject to standard Fermitools Terms and Conditions
given in full below.

------------------------------------------------------------------------

                             PRODUCT DESCRIPTION
                             ===================
rgang is a tool which allows one to execute commands on or distribute files
to many nodes (computers). It incorporates an algorithm to build a tree-like
structure (or "worm" structure) to allow the distribution processing time to 
scale very well to 1000 or more nodes.


Documentation
-------------
Documentation is included with the product/software. An online version can
be found at: http://fnapcf.fnal.gov/~ron/rgang/



Required Hardware and Software
------------------------------
In the case that a "frozen" version of rgang does not work, users will need to
also have python.

Product Installation
--------------------
Copy the python script (<distdir>/bin/rgang.py) _or_ 
python "frozen" version (<distdir>/bin/rgang) to
  /usr/local/bin or /usr/bin or where every you
choose, renaming it to whatever you choose.

Note <distdir>/bin/rgang is the python "frozen" version of rgang.py.
It allows for the _possibility_ to run rgang on a system which does 
not have python. So on systems with python, <distdir>/bin/rgang is not needed.
The "frozen" version may not work on your system due to incompatibilities
between it and the system that the frozen version was created on.

If the default "r" commands are not appropriate,
the python script can be modified OR a "pre-script"
created that sets the appropriate options
and then exec's the python script or
"frozen" version.  Example:
   #!/bin/sh
   # this script file can be named "rgang"
   exec python rgang.py --rsh=ssh --rcp=scp "$@"

Note: The bin/rgang executable is a python "froozen" version of rgang.py.
It allows for the _possibility_ to run rgang (bin/rgang) on a system which does 
not have python. So on systems with python, bin/rgang is not needed. You could 
just copy rgang.py to /usr/local/bin/rgang.


Running the Software
--------------------
See the documentation or usage/help from rgang -h or rgang -vh.


------------------------------------------------------------------------

                                   SUPPORT
                                   =======

Help with the installation or use of rgang is available by sending 
mail to

                        [email protected]

which is auto-forwarded to the group in charge of rgang support at 
Fermilab.

This software is furnished by Fermilab on an "as is" basis as a service 
to the wider community with the goal of stimulating collaborative use 
and further development.

Provision of the software implies no commitment of support by Fermilab.

The Fermilab Computing Division is open to discussing other levels of 
support for use of the software with responsible and committed users and 
collaborators.

Use of the software in experiments at Fermilab will be assured of a 
level of support as agreed to through the standard Memorandum Of 
Understanding process.

Users may send mail to the mail address given above, with the 
expectation that it will be read and noted.


------------------------------------------------------------------------

                         TERMS AND CONDITIONS IN FULL
                         ============================
                         
------------------------------------------------------------------------
    Fermitools Software Legal Information - June 16, 1999
------------------------------------------------------------------------

COPYRIGHT STATUS:  Fermi National Accelerator Laboratory (FNAL)
documents are sponsored by the U.S. Department of Energy under Contract
No. DE-AC02-76CH03000. Therefore, the U.S. Government retains a
non-exclusive, royalty-free license to publish or reproduce these
documents or software for U.S. Government purposes.  All documents
and software available from this server are protected under the U.S.
and Foreign Copyright Laws, and FNAL reserves all rights.

EXPORT CONTROL:  All documents and software available from this server are
subject to U.S. export control laws.  Anyone downloading information from
this server is obligated to secure any necessary Government licenses before
exporting documents or software obtained from this server.  Failure to
obtain export licenses may result in penalties, including fines and/or
imprisonment, under U.S. laws.

Terms and Conditions
--------------------
o   Distribution of the software available from this server is free of
    charge.

When a User obtains a software package included in the Fermilab Software
Tools Program, the user agrees to abide by the Terms and Conditions of the
Program below:

o   Any redistribution and/or modification of the software shall be
    accompanied by this README file.

o   The User shall acknowledge the origin of the software as set forth
    below:

        "This work was performed at Fermi National Accelerator
         Laboratory, operated by Universities Research Association,
         Inc., under contract DE-AC02-76CH03000 with the U.S. Department
         of Energy."

o   The user is asked to feed back problems, benefits, and/or
    suggestions about the software to the Fermilab Software Providers
    and/or Fermitools management.


Indemnification by User of Third Party Claims and
Disclaimer of Liability
-----------------------------------------------------------------------
The User, his/her directors, officers, employees, and agents hereby
release and waive all claims against Universities Research Association,
Inc. (URA) operator of Fermi National Accelerator Laboratory, its
trustees, overseers, directors, officers, employees, agents,
subcontractors, successors and assigns, for any and all liability and
damages arising from the reproduction, use or other disposition of the
software.  The User agrees that URA, its trustees, overseers, directors,
officers, employees, agents, subcontractors, successors and assigns shall
not be liable under any claim, charge, or demand, whether in contract, tort,
criminal law, or otherwise, for any and all loss, cost, charge, claim,
demand, fee, expense,or damage of every nature and kind arising out of,
connected with, resulting from or sustained as a result of the use of the
software programs available from this server.  In no event shall URA be
liable for special, direct, indirect or consequential damages,
losses, costs, charges, claims, demands, fees or expenses of any nature
or kind.

The User shall indemnify URA and the U.S. Government for all damages, costs
or expenses, including attorney's fees, arising from the utilization of the
software, including, but not limited to, the making, using, selling or
exporting of products, processes or services derived from the Software.  The
User agrees to indemnify, hold harmless and defend URA, its trustees,
overseers, directors, officers, employees, agents, subcontractors,
successors and assigns, against any and all liability, damage, loss, cost,
charge, claim, demand, fee or expense of every nature and kind which may at
any time hereafter be sustained by URA by reason of claims of third parties
arising out of alleged acts or omissions of the User in the reproduction,
use or other disposition of the Software.



Disclaimer of Warranties
------------------------
The software is provided on an "as is" basis only.  URA makes no
representations, express or implied.  URA MAKES NO REPRESENTATIONS OR
WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE, or
assumes any legal liability or responsibility for the accuracy,
completeness, or usefulness of any information, apparatus, product or
process disclosed, or represents that the Software will not infringe
any privately held patent, copyright, or trademark.  The entire risk
as to the results and the performance of this software is assumed by
the User.

Disclaimer of Endorsement
-------------------------
Reference herein to any specific commercial products, process, or
service by tradename, trademark, manufacturer or otherwise, does not
constitute or imply its endorsement, recommendation, or favoring by
the United States Government, U.S. Department of Energy or URA.  The
views and opinions of individuals expressed herein do not necessarily
state or reflect those of the United States Government, U.S. Department
of Energy or URA and shall not be used for advertising or product
endorsement purposes.

Liabilities of the Government
-----------------------------
This software is provided by URA, independent from its Prime Contract
with the U.S. Department of Energy.  URA is acting independently from
the Government and in its own private capacity and is not acting on
behalf of the U.S. Government, nor as its contractor nor its agent.
Correspondingly, it is understood and agreed that the U.S. Government
has no connection to this software and in no manner whatsoever shall be
liable for nor assume any responsibility or obligation for any claim,
cost, or damages arising out of or resulting from the use of the
software available from this server.
------------------------------------------------------------------------