Installation

Stable release

To install STAVER, run this command in your terminal:

$ pip install staver

This is the preferred method to install STAVER, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

Note

To avoid potential dependency conflicts, installing within a conda environment is recommended.

From sources

The sources for STAVER can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/Ran485/staver

Or download the tarball:

$ curl -OJL https://github.com/Ran485/staver/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Environmental dependencies

The STAVER package use some functions for the data processing, leveraging the open-source Python packages.

You may install additional environmental dependencies:

$ pip install -r requirements_dev.txt
$ pip install -r requirements.txt

Note

To avoid potential dependency conflicts, installing within a conda environment is recommended.

Now you are all set. Proceed to tutorials for how to use the STAVER package.