2. Installation

2.1. Disclaimer

Yaff is developed and tested on modern Linux environments. The installation instructions below are given for a Linux system only. If you want to use Yaff on other operating systems such as Windows or OSX, you should have a minimal computer geek status to get it working. We are always interested in hearing from your installation adventures.

2.2. External dependencies

Some software packages should be installed before Yaff can be installed or used. It is recommended to use the software package management of your Linux distribution to install these dependencies.

The following software must be installed:

Most Linux distributions can install this software with just a single terminal command.

  • Ubuntu

    sudo apt-get install gcc g++ python-dev python-numpy cython python-h5py python-matplotlib python-nose python-scipy

  • Fedora pre 22

    sudo yum install gcc gcc-c++ redhat-rpm-config python-devel numpy cython h5py python-matplotlib python-nose sphinx scipy

  • Fedora 22 and later

    sudo dnf install gcc gcc-c++ redhat-rpm-config python-devel numpy cython h5py python-matplotlib python-nose sphinx scipy

2.3. Installation

You can install Yaff with pip (in your home directory):

pip install numpy Cython --user
pip install yaff --user

or in system wide or in a virtual environment:

pip install numpy Cython
pip install yaff

Alternatively, you can also install yaff with conda. See https://www.continuum.io/downloads

conda install -c molmod yaff

2.4. Test your installation

Execute the following commands to run the tests:

nosetests -v yaff

If some tests fail, you can post on issue on https://github.com/molmod/yaff/issues