Java CoG Kit Guides

Gregor von Laszewski

Software Version: 4_1_2
Manual version: 02/18/05
Url: http://www.cogkit.org/release/4_1_2/manual/guide.pdf
Url: http://www.cogkit.org/release/4_1_2/manual/guide/guide.html
Last update: July 11, 2005

Contents

1 About this Document
 1.1 Reproduction
 1.2 Viewing
 1.3 Format
2 Registration
3 Introduction
4 Contributing a Guide
5 Which Guides are Available?
6 Which Guides are under development?
7 Which Guides are Planed?
8 Which Guides are under development?
Appendix
A Java CoG Kit Guides
B Java CoG Kit Guides Under Construction
C Available Downloads
D Availability of the Document
E Bugs
F Administrative Contact

 

1 About this Document

This document includes basic information about the different Java CoG Kit guides in order to help you find documentation about the Java CoG Kit.

1.1 Reproduction

The material presented in this document can not be published, mirrored, electronically or otherwise reproduced without prior written consent. As you can link to this document, this should not pose much of a restriction.

1.2 Viewing

The best way to read this document is with Adobe Acrobat Reader. Please make sure you configure Adobe Acrobat Reader appropriately so you can follow hyperlinks. This is the case if you follow the default installation. Acrobat Reader is available at http://www.adobe.com/products/acrobat/readermain.html. Because the hyperlinks are not available in the printed form of this manual and we support saving our environment we strongly discourage printing this document.

We recommend that you save this manual locally on your machine and use Acrobat Reader. This has the advantage that you do not lose your anchor points while switching back and forth between different hyperlinks. An HTML version of this manual is planed, but not available yet.

1.3 Format

We have augmented the document with some comments at places where we found issues. Our intend is to address these issues in a future release. The comments are marked by the icon  to do  and the name of the person that will work on the removal of the issue.

2 Registration

Please be a team player and support us indirectly by registering with us or reporting your use of the Java CoG Kit. Although this software is free, we still need to justify to our funders the usefulness of the projects. If you want to help us with our efforts please take a few seconds to complete this information. We do not use this information for other purposes. If you have special needs or concerns please contact gregor@mcs.anl.gov. The registration form can filled out in a variety of formats. The online form can be found at

http://www.cogkit.org/register

This form is available also as ASCII text at

http://www.cogkit.org/register/form.txt

which you can FAX to

Gregor von Laszewski, Fax: 630 252 1997

3 Introduction

Originally, we distributed a single manual with the Java CoG Kit. We had two different attempts to join the documentation, but because we needed so much time to keep up with different Grid middleware solutions our attempt to keep this manuals up to date have not yet been as successful as we wished.

In an effort to distribute the documentation among a group of people, we have decided to separate the chapters and make them available as guides. Once we have multiple guides together, we intend to join them in a single manual. But for now we like to give you already access to our preliminary contents and to encourage others to contribute to the effort of writing such guides.

The guides in this document are related to the Java CoG Kit version 4_1_2. Guides that contain -dev in the name are particularly targeted to the developers of the Java CoG Kit.

4 Contributing a Guide

You can contribute a guide to us by contacting gregor@mcs.anl.gov. Guides can be written in any format including word, HTML, and ASCII. We will convert these guides in the format you see here. To assist us in doing so, please make sure that all images must be provided in separate files as png and as original, with a note which program created this image. In case you like to use the format you see here, please download this sample form the CVS as described in the appendix and modify it appropriately. Writing guides in our format is highly trivial.

5 Which Guides are Available?

At this time we have the following guides available:

Guide:
A guide to help you finding out what guides have been written
[PDF] [HTML].
Install:
A guide to the different ways of installing the Java CoG Kit
[PDF] [HTML]

6 Which Guides are under development?

Security:
A guide to GSI security
Release:
A guide to the Java CoG Kit release process
[PDF] [HTML].
Workflow:
A guide to the Gridant/Karajan Workflow
[PDF] [HTML]

7 Which Guides are Planed?

At this time we have the following subject guides planed, however we have not yet started them. Your input and participation in writing them is welcome:

8 Which Guides are under development?

TBD

References

[1]   G. von Laszewski, I. Foster, J. Gawor, and P. Lane, “A Java Commodity Grid Kit,” Concurrency and Computation: Practice and Experience, vol. 13, no. 8-9, pp. 643–662, 2001. [Online]. Available: http://www.mcs.anl.gov/~gregor/papers/vonLaszewski--cog-cpe-final.pdf

[2]   “Java CoG Kit Wiki,” 2004. [Online]. Available: http://www.cogkit.org/wiki

[3]   “Java CoG Kit Registration,” 2004. [Online]. Available: http://www.cogkit.org/register

Additional publications about the Java CoG Kit can be found as part of the vita of Gregor von Laszewski http://www-unix.mcs.anl.gov/~laszewsk/vita.pdf. Most documents are avalable online if you follow the links. In future we intend to provide this information without Gregors vita data.

If you need to cite the Java CoG Kit, please use [1].

Appendix

A Java CoG Kit Guides




Short Title Description Format



Guide A guide to help you finding out what guides have been written[PDF] [HTML]



Install A guide to the different ways of installing the Java CoG Kit [PDF] [HTML]



Commands A guide to the command line tools of the Java CoG Kit [PDF] [HTML]



Workflow A guide to the Gridant/Karajan Workflow [PDF] [HTML]



AbstractionsA guide to the Java CoG Kit abstractions API [PDF] [HTML]



JavaDoc The Java API documentation to the Java CoG Kit [HTML]



Coding A guide to the Coding rules for the Java CoG Kit [PDF] [HTML]



Overview A future guide that will be an overview to the Java CoG Kit [PDF] [HTML]



B Java CoG Kit Guides Under Construction

More guides are under development. The following guides are not yet completed, but are listed here to help us improving these guides. Please, explore them and send us e-mail about improvement suggestions. If you like to contribute a guide yourself, please contact gregor@mcs.anl.gov.




Short Title Description Format



MPI A preliminary guide to execute MPI programs on the TeraGrid and alike[PDF] [HTML]



Release ProcessA preliminary guide to document the release process [PDF] [HTML]



Guide A preliminary guide to document writing guides [PDF] [HTML]



Examples A preliminary guide to examples alike [PDF] [HTML]



C Available Downloads

First time users of the Java CoG Kit should read the “Guide to Installing the Java CoG Kit” [PDF] [HTML]. We hope that you will find this guide useful to decide which bundles you need. For the more experienced user, we provide the following table.

Binary Distributions
 
Source Distributions
 
API Documentation
 
Module List
 
CVS
 

D Availability of the Document

The newest version of this document can be downloaded by the developers from

  1. cvs -d:pserver:anonymous@cvs.cogkit.org:/cvs/cogkit checkout manual/guide

It is not allowed to reproduce this document or the source. This documentation is copyrighted and is not distributed under the CoG Kit license.

E Bugs

This guide is constantly improved and your input is highly appreciated. Please report suggestion, errors, changes, and new sections or chapters through our Bugzilla system at

http://www-unix.globus.org/cog/contact/bugs/

F Administrative Contact

The Java CoG Kit project has been initiated and is managed by Gregor von Laszewski. To contact him, please use the information below.

Gregor von Laszewski
Argonne National Laboratory
Mathematics and Computer Science Division
9700 South Cass Avenue
Argonne, IL 60439
Phone:(630) 252 0472
Fax: (630) 252 1997
gregor@mcs.anl.gov

Index

Administrative Contact, 6

Contact, 6

Registration, 2