Installation

Setup

Spinney is available one the Python Package Index, the most simple way to install it is using pip:

pip install spinney

After the installation is completed, you can run some tests in order to see if the installation was successfull.

To do so, run the command:

spinney-run-tests

The Spinney package is also hosted on Gitlab.

In this case, to install the package, create a new directory and clone the repository. From the root directory, run the command:

python3 setup.py install

And to check if the installation was successfull, type:

python3 setup.py test

Note

We recommend to install Spinney within a Python virtual environment, such as those created by Virtualenv.

Requirements

Spinney requires Python3 and the following libraries:

  • NumPy version 1.12 or newer;

  • SciPy version 1.4 or newer;

  • Pandas version 0.25 or newer;

  • Matplotlib version 3.1.0 or newer;

  • ASE version 3.18 or newer.

    Warning

    Spinney is not compatible with ASE versions older than the 3.18 one.