Teuthis documentation

About

Documentation

Requirements

Installation

Requirements

Teuthis is written in Python and uses the GTK+ graphics library. To run Teuthis, you must have the following packages (or later versions) installed on your system:

		Python version 2.0
		PyGTK version 2.4
		libglade version 2
		pexpect version 0.999 (a version of pexpect.py modified to retry reads on EINTR signals is included with Teuthis)

To use remote machines from within Teuthis, you also need to have at least one of the following client packages installed:

		OpenSSH or GSI-enabled OpenSSH
		Kerberos

To make use of Grid services for single signon authentication and third-party file transfers, you need to have GSI-enabled OpenSSH and the Globus Toolkit (version 4.0) installed. (At this time pyGlobus is not required.) Teuthis can also make use of the following optional Grid software packages:

		UberFTP file transfer client
		MyProxy credential management client

To build these Grid tools from source, it helps to have the Grid Packaging Toolkit installed.

Finally, to take notes you will need a text editor and/or web browser.

At present Teuthis is only supported under Linux. However, its dependencies are all open-source projects with versions available for Windows and Macintosh computers, so it should be usable on these systems as well. Users with these systems are invited to try out Teuthis and share their experiences with us.

Installing Teuthis

To install Teuthis, make sure you have installed the required packages, then follow these instructions:

Obtain the appropriate Teuthis installation archive file from our downloads page.
Extract the Teuthis files from the archive using the command zcat file | tar xvf -, where file is the name of the archive file you downloaded. This will create a directory named teuthis-XX/, where XX is the version number.
Move to this directory and execute the install-teuthis script found there. Note that if you plan to install Teuthis into a system-wide directory such as /usr/local/, you will need to have system administrator privileges for this step.
The installation script will ask you for the directory into which the Teuthis directory should be placed. For example, if you choose /usr/local/, the Teuthis files will be copied into /usr/local/teuthis-XX. You will also be asked if you would like to create symbolic links to the teuthis.py and tendril.py scripts in another directory like /usr/local/bin/.
The script will create directories and links and copy files as needed. No compilation is required. After the script is finished, you may start Teuthis by running teuthis-dir/bin/teuthis.py, where teuthis-dir is the directory into which you installed Teuthis in the previous step. If you chose to create links in a directory that is in your path, you may also simply issue the command teuthis.

User's guide

An HTML copy of the user's guide is included with each Teuthis distribution and can be accessed from the Help menu in Teuthis. You can also view the documentation online using the links below.

Version 1.0

FAQ

Frequently asked questions will be answered here.

License

University of Illinois/NCSA Open Source License

Developed by:

   Cosmological Simulation Group/Cyberinfrastructure Projects
   National Center for Supercomputing Applications (NCSA)
   http://sipapu.astro.illinois.edu/projects/teuthis

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal with the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimers.

Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimers in the documentation and/or other materials provided with the distribution.

Neither the names of NCSA, the University of Illinois, nor the names of contributors to this software may be used to endorse or promote products derived from this Software without specific prior written permission.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH THE SOFTWARE.

Paul Ricker

09/15/16