# Installation Guide

Installing PubTal

Instructions for the following platforms are available:

- Linux/Unix - Covers Linux and most other Unix based systems.
- MacOS X
- Windows

## Linux/Unix Installation Instructions

### Step 1: Install Python

Most Linux distributions install Python by default. If it isn't present on your system then download it from your vendor's website or Python.org.

### Step 2: Install SimpleTAL

Download the latest version of SimpleTAL and install by following these steps:

1. Unzip the SimpleTAL archive (e.g. `gunzip SimpleTAL-3.11.tar.gz`)
2. Un-tar the archive (e.g. `tar -xf SimpleTAL-3.11.tar`)
3. Become the root user using `su -`
4. Use `python setup.py install` to install SimpleTAL

### Step 3: Install PubTal

To install PubTal follow these steps:

1. Unzip the PubTal archive (e.g. `gunzip PubTal-3.1.2.tar.gz`)
2. Un-tar the archive (e.g. `tar -xf PubTal-3.1.2.tar`)
3. Become the root user using `su -`
4. Use `python setup.py install` to install PubTal

#### Step 4: Verify installation

To ensure that PubTal has installed correctly:

1. Go the `examples/homepage` directory
2. Run `updateSite.py site.config` - the website should be built.

## MacOS X Installation Instructions

MacOS X already comes with Python installed, so only SimpleTAL and PubTal need to be added.

### Step 1: Install SimpleTAL

Download the latest version of SimpleTAL and install by following these steps:

1. Ensure that /usr/local/bin is in your path. If you are using the default tcsh then add the following line to your .cshrc file:`set path=( $path /usr/local/bin )`
2. Unzip the SimpleTAL archive (e.g. `gunzip SimpleTAL-3.11.tar.gz`)
3. Un-tar the archive (e.g. `tar -xf SimpleTAL-3.11.tar`)
4. Run `sudo python setup.py install --install-scripts /usr/local/bin`
5. Close the terminal program and re-open it.

### Step 2: Install PubTal

To install PubTal follow these steps:

1. Unzip the PubTal archive (e.g. `gunzip PubTal-3.1.2.tar.gz`)
2. Un-tar the archive (e.g. `tar -xf PubTal-3.1.2.tar`)
3. Run `sudo python setup.py install --install-scripts /usr/local/bin`
4. Close the terminal program and re-open it.

#### Step 4: Verify installation

To ensure that PubTal has installed correctly:

1. Go the `examples/homepage` directory
2. Run `updateSite.py site.config` - the website should be built.

## Windows Installation Instructions

### Step 1: Install Python

Windows does not come with Python pre-installed. Download the latest stable version from Python.org and follow the instructions there.

### Step 2: Install SimpleTAL

Download the latest version of SimpleTAL and install by following these steps:

1. Unzip the SimpleTAL archive (WinZip supports .tar.gz files)
2. Select Start->Run and enter "cmd" in the text box and select "OK"
3. Change to the SimpleTAL directory (e.g. `cd C:\SimpleTAL-3.11`)
4. Type `C:\Python23\python.exe setup.py install` (changing C:\Python23 for the directory where you installed Python)

### Step 3: Install PubTal

To install PubTal follow these steps:

1. Unzip the PubTal archive (WinZip supports .tar.gz files)
2. Select Start->Run and enter "cmd" in the text box and select "OK"
3. Change to the PubTal directory (e.g. `cd C:\PubTal-3.1.2`)
4. Type `C:\Python23\python.exe setup.py install` (changing C:\Python23 for the directory where you installed Python)

#### Step 4: Verify installation

To ensure that PubTal has installed correctly:

1. Go the examples/homepage directory
2. Run the updateSite.py command (e.g. `C:\Python23\Scripts\updateSite.py site.config`) - the website should be built.

PubTal Version 3.5