Installation

Installation

This document aims to provide a simple step-by-step instruction for installing SHARPER. It is assumed that you are using the svn repository to get the files. If you are not you may skip the section on getting the files from the repository.

Before you install

Due to the nature of SHARP's source code it is not readily available for download. Several major packages in SHARP are export controlled and must be obtained from official sources. Before using SHARPER you must have obtained a copy of SHARP from one of these sources. If you need more information about getting a copy of SHARP you can go to the about SHARP page.

If you already have a copy of SHARP you may follow the directions below to run the installer.

Getting the files from the svn repository

In a shell terminal the following command can be entered to check out the most up to date files in the repository. You may specify the directory that you wish to download into by changing the 'sharper-code' to the directory you wish.

svn checkout https://svn.code.sf.net/p/sharper/code/ sharper-code

Running the installer

Once the source code has been obtained you may run the install.sh script to install the packages associated with SHARPER. Before doing so, however, it is important to have the path to the SHARP directory available. By default the installer assumes that your copy of SHARP is in HOME/sharp. If this is not the case you will need to use the prefix option to specify where the SHARP directory is. For information about how to use the prefix option read the following section on installer options.

To run the installer set your working directory to sharper-code and run the command

./install.sh -options

Setting the Path

After the install script has finished running you must set your path. The "pathMaker" file will contain all of the necessary additions to the path for you to use SHARPERs tools. Run the following command from the shell.

source pathMaker

Installer Options

The installer script provides additional functionality through a set of options. Currently supported options are outlined below:

Helper

The help option describes the installer script and gives an up to date list of options and usage conventions. Syntax:

./install.sh -h 
./install.sh --help

Prefix

The prefix option allows the user to specify the directory for the installation of SHARPER. You must specify the location of the SHARP directory. For example, if you have the code to SHARP in ~/someDirectory you will use that as your prefix, and not ~/someDirectory/sharp. Syntax:

./install.sh -p /path/to/sharp
./install.sh --prefix /path/to/sharp

Clean

If you have tried to install SHARP using SHARPER before or have an old or broken install of SHARP it may be necessary for you to run the installer with the "clean" option. This allows you to clear out all of the information from external packages in the SHARP suite. WARNING: this option will delete all of the files in the Libraries folder of the SHARP directory and reset configuration files for the core fo SHARP. Syntax:

./install.sh -c
./install.sh --clean

Install Only

The install only option allows the installation of a single package. For a list of package options use the option with a blank argument. Syntax:

./install.sh -o package_name
./install.sh --only package_name

Optional Package Support

SHARPER provides support for several packages which are not installed by default. These packages can be installed by specifying them in the options list while running the installer. In order for these packages to be installed the options for them must be listed first in the options list. You may use the following options for these packages:

--withSlepc
--withParmetis
--withNice
--withTriangle
--withVTK

Additional Resources

This section is under construction.