Installation

1. Install the necessary software

Python

pampro is a software package written in Python, and therefore requires a Python interpreter to run. It also depends upon several third-party Python libraries that are common in scientific computing. There is a distribution of Python called Anaconda which bundles an interpreter and all the requisite libraries into one convenient installation. Download and install the version most appropriate for you, depending on your operating system (Windows, OS X, Linux), selecting the most recent Python version (currently 3.5).

Git

pampro is version-controlled using Git, and hosted/distributed using GitHub. If you are unfamiliar with Git, there is an excellent interactive Git tutorial that explains its basic usage. Its purpose here is to provide a way for end-users to download the latest version of the code, and any assorted documentation.

2. Download the latest pampro version

Download the code

To get the latest version of the project, enter the following at the command line:

git clone https://github.com/Thomite/pampro.git

This will create a folder called pampro, and download everything from the repository into it. In the future, when changes have been made to the code, you can update to the latest version by navigating to the same folder and entering:

git pull

Install pampro as a Python module

The final step is to compile the provided Python code on your system. Navigate to the top level of the folder structure where pampro is installed (the folder that contains setup.py, the install script) and enter:

ipython setup.py install

If this was successful, there will now be a Python module installed on your system called pampro, which the provided analysis scripts can use to process your data. Finally, enter the following code at the command line:

ipython -c "from pampro import Time_Series"

If you do this and encounter no errors, you have successfully installed pampro.