We provide an installation script which automatically tries to install
GC3pie in your home directory. The quick installation procedure has
only been tested on variants of the GNU/Linux operating
system. (However, the script should work on MacOSX as well, provided
you follow the preparation steps outlined in the “MacOSX installation”
section below.)

To install GC3Pie just type this at your terminal prompt:

sh -c "$(wget -O- http://gc3pie.googlecode.com/svn/install.sh)"

If wget is not installed in your computer, you can use curl instead:

sh -c "$(curl -s http://gc3pie.googlecode.com/svn/install.sh)"

The above command creates a directory $HOME/gc3pie and installs
the latest release of GC3Pie and all its dependencies into it.

In case you have trouble running the installation script, please send
an email to gc3pie@googlegroups.com. (In order to post a message, you
first need to subscribe. To post a message without being subscribed,
please use the web interface at
http://dir.gmane.org/gmane.comp.python.gc3pie.) Include the full
output of the script in your email, in order to help us to identify
the problem.

Now you can check your GC3Pie installation; follow the on-screen
instructions to activate the virtual environment. Then, just type the
command:

gc3utils--help

and you should see the following output appear on your screen:

Usage: gc3utils COMMAND [options]
Command `gc3utils` is a unified front-end to computing resources.
You can get more help on a specific sub-command by typing::
gc3utils COMMAND --help
where command is one of these:
clean
cloud
get
info
kill
resub
select
servers
stat
tail

With the default configuration file, GC3Pie is set up to only run
jobs on the computer where it is installed. To run jobs on remote
resources, you need to edit the configuration file; the
ConfigurationFile Wiki page
provides an explanation of the syntax.

In this step and in the following ones, the directory
$HOME/gc3pie is going to be the installation folder of GC3Pie.
You can change this to another directory path; any directory that’s
writable by your Linux account will be OK.

If you are installing system-wide as root, we suggest you
install GC3Pie into /opt/gc3pie instead.

Check-out the gc3pie files in a src/ directory:

svn co http://gc3pie.googlecode.com/svn/branches/2.0/gc3pie src

Install the gc3pie in “develop” mode, so any modification
pulled from subversion is immediately reflected in the running environment:

This will place all the GC3Pie command into the gc3pie/bin/
directory.

GC3Pie comes with driver scripts to run and manage large families
of jobs from a few selected applications. These scripts are not
installed by default because not everyone needs them.

Run the following commands to install the driver scripts for the
applications you need:

# if you are insterested in GAMESS, do the following
ln -s '../src/gc3apps/gamess/ggamess.py' bin/ggamess
# if you are insterested in Rosetta, do the following
ln -s '../src/gc3apps/rosetta/gdocking.py' bin/gdocking
ln -s '../src/gc3apps/rosetta/grosetta.py' bin/grosetta
# if you are insterested in Codeml, do the following
ln -s '../src/gc3apps/codeml/gcodeml.py' bin/gcodeml

Now you can check your GC3Pie installation; just type the command:

gc3utils--help

and you should see the following output appear on your screen:

Usage: gc3utils COMMAND [options]
Command `gc3utils` is a unified front-end to computing resources.
You can get more help on a specific sub-command by typing::
gc3utils COMMAND --help
where command is one of these:
clean
cloud
get
info
kill
resub
select
servers
stat
tail

If you get some errors, do not despair! The GC3Pie users
mailing-list <gc3pie@googlegroups.com> is there to help you :-)
(You can also post to the same forum using the web interface at
http://dir.gmane.org/gmane.comp.python.gc3pie.)

With the default configuration file, GC3Pie is set up to only run
jobs on the computer where it is installed. To run jobs on remote
resources, you need to edit the configuration file; the
ConfigurationFile Wiki page
provides an explanation of the syntax.

If you used the installation script, the fastest way to upgrade is just to reinstall:

De-activate the current GC3Pie virtual environment:

deactivate

(If you get an error “command not found”, do not worry and proceed
on to the next step; in case of other errors please stop here and
report to the GC3Pie users mailing-list
<mailto:gc3pie.googlegroups.com>.)

Move the $HOME/gc3pie directory to another location, e.g.:

mv $HOME/gc3pie $HOME/gc3pie.OLD

Reinstall GC3Pie using the quick-install script (top of this page).

Once you have verified that your new installation is working, you
can remove the $HOME/gc3pie.OLD directory.

If instead you installed GC3Pie using the “manual installation” instructions,
then the following steps will update GC3Pie to the latest version
in the code repository:

cd to the directory containing the GC3Pie virtualenv;
assuming it is named gc3pie as in the above installation
instructions, you can issue the commands:

cd $HOME/gc3pie # use '/opt/gc3pie' if root

Activate the virtualenv:

source bin/activate

Upgrade the gc3pie source and run the setup.py script again:

cd src
svn up
env CC=gcc ./setup.py develop

Note: A major restructuring of the SVN repository took place in
r1124 to r1126 (Feb. 15, 2011); if your sources are older than SVN
r1124, these upgrade instructions will not work, and you must
reinstall completely. You can check what version the SVN sources
are, by running the svn info command in the src directory: watch
out for the Revision: line.

Installation on MacOSX machines is possible, however there are still a
few issues. If you need MacOSX support, please let us know on the
GC3Pie users mailing-list <mailto:gc3pie@googlegroups.com> or by
posting a message using the web interface at
http://dir.gmane.org/gmane.comp.python.gc3pie.

Standard usage of the installation script (i.e., with no options)
works, but you have to use curl since wget is not installed by
default.

In order to install GC3Pie you will need to install XCode and,
in some of the MacOSX versions, also the Command Line Tools for
XCode

Options can only be given in the abbreviated one-letter form (e.g.,
-d); the long form (e.g., --directory) will not work.

The shellcmd backend of GC3Pie depends on the GNU time
command, which is not installed on MacOSX by default. This means
that with a standard MacOSX installation the shellcmd resource
will not work. However:

other resources, like pbs via ssh transport, will work.

you can install the GNU time command either via MacPorts,
Fink, Homebrew or from the this url. After installing it
you don’t need to update your PATH environment variable, it’s
enough to set the time_cmd option in your GC3Pie
configuration file.