-
Notifications
You must be signed in to change notification settings - Fork 9
Installation Instructions
The easiest way to install PH5 is to use the Anaconda distribution of python. These instructions only cover installation of PH5 dependencies using Anaconda. This is because PH5 (and many python tools) require packages (aka modules) that have C dependencies.
Anaconda is not an absolute requirement to get PH5 to work. As long as you can get the necessary python dependencies installed, PH5 will work. If you want to install Anaconda (highly recommended), follow the Mac or Linux instructions below.
After downloading the Anaconda version 2.7 installer from https://www.anaconda.com/distribution/, double click the .pkg file and follow the instructions on the screen. Use all of the defaults for installation.
After downloading the Anaconda version 2.7 installer from https://www.anaconda.com/distribution/ execute the associated shell script. For example, if the file downloaded were named Anaconda2-4.4.0-Linux-x86_64.sh you would run bash Anaconda2-4.4.0-Linux-x86_64.sh in the directory where you downloaded the file.
Below are instructions for installing PH5 with Anaconda. PH5 has several system requirements that are necessary for installation. If you are using Anaconda these system requirements are preinstalled with Anaconda, making for a much simpler installation.
- Open a terminal.
- Install Git if you do not have it
- Clone the PH5 project from GitHub to your local machine by running
git clone https://github.com/PIC-IRIS/PH5.gitor downloading the zip file for the latest PH5 release. - Add the conda-forge channel to your Anaconda configuration by running
conda config --add channels conda-forge - Set the Restore Free Channel flag to True by running
conda config --set restore_free_channel true(only necessary for users of Conda version 4.7+) - Install PH5 one of the dependency sets into the environment from the PH5 directory created by git by running:
- For full installation with GUI packages
conda env create --name=ph5 -f /path/to/ph5/environment-gui.yml - For core installation without GUI packages
conda env create --name=ph5 -f /path/to/ph5/environment.yml
- For full installation with GUI packages
- Source the newly created ph5 environment by running
conda activate ph5(note: you must be using bash as your shell for this to work) - Install the PH5 python package by running
pip install -e .in the cloned PH5 project root directory.
Once installed, executing command line tools in PH5 couldn't be easier. To run a utility, enter the name of the utility's executable that you wish to run anywhere on the command line.
Please see the PH5 Commands page for a complete list of commands.