Skip to content

Installation on Linux

Johannes Niediek edited this page Sep 21, 2020 · 7 revisions

Combinato Installation Instructions for Linux

1. Getting the code

If you use git, clone the repository:

git clone https://github.com/jniediek/combinato.git

If you do not use git, download Combinato from https://github.com/jniediek/combinato/archive/master.zip.

2. Installing dependencies

It is possible to skip this step and come back in case of dependcy problems.

Combinato depends on scipy, pywt, matplotlib, pytables, and pyqt. Most modern Linux distributions have these packages installed by default. If you miss any of these packages, use your distribution's package manager to install them.

For example, in Ubuntu and Debian

sudo apt-get install python3-scipy python3-matplotlib python3-pywt python3-tables python-pyqt5

installs all dependencies.

3. Setting up the environment

3.1 Choosing the right clustering backend

Combinato uses a compiled executable file as backend for clustering. To automatically select the correct file for your operating system, navigate your shell to the Combinato repository and run

python3 setup_options.py.

3.2 Setting Paths

Combinato is organized as a collection of executable scripts. These are the files named css-* in the repository's main folder. To be able to execute these scripts, add the repository's folder to your $PATH as shown below.

For some of the tools in the subdirectories signalviewer and tools, it is necessary to add the repository's folder to $PYTHONPATH as well.

For example, my Combinato repository is in

/home/johannes/combinato

and my shell's configuration (/home/johannes/.bashrc) contains

PATH=$PATH:/home/johannes/combinato
PYTHONPATH=$PYTHONPATH:/home/johannes/combinato
export PATH PYTHONPATH

4. Testing the Installation

  1. Open a new shell
  2. Navigate to the Combinato repository
  3. Enter python3 tools/test_installation.py

In case everything worked, you will see the following output:

Found Combinato
Found SPC binary
Your version of pytables is 3.6.1
Combinato clustering setup: no problems detected.
Found display
Found 'montage', plotting continuous data possible.

5. Running the Tutorial

You are now ready to do the Combinato tutorial.

6. Support

In case of any errors, feel free to contact me (Johannes) at [email protected].