Installation

There are two different ways to install sterope:

  1. Install sterope natively (Recommended).

    OR

  2. Clone the Github repository. If you are familiar with git, sterope can be cloned and the respective folder added to the python path. Further details are below.

Note

Need Help? If you run into any problems with installation, please visit our chat room: https://gitter.im/glucksfall/pleiades

Option 1: Install sterope natively on your computer

The recommended approach is to use system tools, or install them if necessary. To install python packages, you could use pip, or download the package from python package index.

  1. Install with system tools

    With pip, you simple need to execute and sterope will be installed on $HOME/.local/lib/python3.6/site-packages folder or similar.

    pip3 install sterope --user

    If you have system rights, you could install sterope for all users with

    sudo -H pip3 install sterope

  2. Download from python package index

    Alternatively, you could download the package (useful when pip fails to download the package) and then install with pip. For instance:

    wget https://files.pythonhosted.org/packages/01/db/582f9d3c34c840117e8fd19c9de4d9745508718765e48a808427005f16dd/sterope-1.5-py3-none-any.whl
pip3 install sterope-1.5-py3-none-any.whl --user

    Note

    Why Python3?: Pleione is intended to be used with python3, despite the lack of incompatible functions with python2, because the latter won’t receive further development past 2020.

    Note

    pip, Python and Anaconda: Be aware which pip you invoque. You could install pip3 with sudo apt-get install python3-pip if you have system rights, or install python3 from source, and adding <python3 path>/bin/pip3 to the path, or linking it in a directory like $HOME/bin which is commonly added to the path at login. Also be aware that, if you installed Anaconda, pip could be linked to the Anaconda specific version of pip, which will install pleione into Anaconda’s installation folder. Type which pip or which pip3 to find out the source of pip, and type python -m site or python3 -m site to find out where is more likely pleione will be installed.

Option 2: Clone the Github repository

  1. Clone with git

    The source code is uploaded and maintained through Github at https://github.com/glucksfall/sterope. Therefore, you could clone the repository locally, and then add the folder to the PYTHONPATH. Beware that you should install the salib, pandas, dask, and dask-jobqueue packages by any means.

    git clone https://github.com/glucksfall/sterope /opt
echo export PYTHONPATH="\$PYTHONPATH:/opt/sterope" >> $HOME/.profile

    Note

    Adding the path to $HOME/.profile allows python to find the package installation folder after each user login. Similarly, adding the path to $HOME/.bashrc allows python to find the package after each terminal invocation. Other options include setting the PYTHONPATH environmental variable in a sh file (see the example folder) or invoke python3 setup.py clean build install to install Pleione as it was downloaded from the PyPI server.