NetLogger-Python README
=======================
Dan Gunter <dkgunter@lbl.gov>
$Id: README 26569 2010-10-06 22:26:56Z taghrid $


This is the README for the Python part of the NetLogger Toolkit.

Installation
~~~~~~~~~~~~

All files install with the Python distutils script, setup.py.

To install in the default location:
---------------------------
$ python setup.py install
---------------------------

To install somewhere else:
---------------------------
$ export NETLOGGER_HOME=/path/to/home
$ python setup.py install --home=$NETLOGGER_HOME
$ export PYTHONPATH=$NETLOGGER_HOME/lib/python
$ export PATH=$PATH:$NETLOGGER_HOME/bin
---------------------------

Note that for csh and derivatives, replace
'export foo=bar' with 'setenv foo bar'.

If you are running out of subversion in the checkout directory,
simply go to the directory with this file and run:
----------------------
$ source dev-setup.sh # for sh/bash/etc.
% source dev-setup.csh # for csh/tcsh/etc.
----------------------

Tests
~~~~~
All the NetLogger tests are under the subdirectory ./netlogger/tests
There is a Makefile with some high-level commands, if run with no 
commands it lists the available ones.
To run unit tests, install or source the dev-setup script, then:
----------------------
$ cd netlogger/tests
$ make unit
----------------------

Manual pages and API documentation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

All documentation has moved under the top-level doc/ directory.

The tool manual pages are in the NetLogger manual in doc/manual/man.
The API documentation is in doc/api/python.
Use Makefiles in those directories to build/install the documentation.

The tools installed in the installation bin/ directory all respond to
the -h option, and should have a reasonable up-to-date manual page.

For documentation of all releases, see:
http://acs.lbl.gov/NetLoggerWiki/index.php/Documentation

The new wiki documentation, which is not yet complete, is at:
http://netlogger.lbl.gov/

Contact and more info
---------------------
Please see the NetLogger wiki at http://acs.lbl.gov/NetLoggerWiki for
details on how to use NetLogger.

You may also send email to the NetLogger mailing lists: 
* For bugs and technical questions: nl-dev@globus.org
* For usage and general questions: nl-user@globus.org
