How to Install

Jose Miguel de la Rosa Trevin edited this page Feb 19, 2017 · 56 revisions
Clone this wiki locally
Scipion Logo

Installing Scipion in 3 Steps

Step1: Download

You can install Scipion anywhere, as long as you have write permissions. If you want to share Scipion installation among different users you can use /usr/local or a similar path. If it is only for you, you can use your home directory as well.

Go to the directory where you want to install Scipion, and download it using one of the following ways:

From Scipion Webpage

Go to Scipion Download Page, select either precompiled binaries or source code and fill the download form (this information is only used for download statistics). When the download is completed, you should have a compressed file like scipion_v1.0.0_150130.tgz. Move that file to the installation directory and decompress using tar:

tar xvzf scipion_v1.0.0_150130.tgz

From GitHub

Clone Scipion repository (install git if not present in your system):

git clone https://github.com/I2PC/scipion.git
cd scipion

Git will create a scipion directory under your current path; you do not need to create it manually.

Step2: Dependencies

From Pre-compiled Binaries

If you have download the Scipion binary version, you need only to install some dependencies (this example is for Debian/Ubuntu distros. See for Fedora and SuSE):

sudo apt-get install openjdk-8-jdk libopenmpi-dev openmpi-bin gfortran

From Source Code

To install Scipion from source, some development libraries are required. You can install them with (this example is for Debian/Ubuntu distros. See for Fedora and SuSE):

sudo apt-get install gcc g++ cmake openjdk-8-jdk libxft-dev libssl-dev libxext-dev libxml2-dev libreadline6 libquadmath0 libxslt1-dev libopenmpi-dev openmpi-bin libxss-dev libgsl0-dev libx11-dev gfortran libfreetype6-dev

Step3: Configure and Install

Configure

After installing the dependencies, you can proceed to generate configuration files.

cd scipion
./scipion config

This command will generate the configuration files (if not present) and will try to automatically find configuration paths.

If everything is OK (all green in the output) you can proceed to next step. If there is a problem (red output), you will need to edit config/scipion.conf file in your preferred text editor and run ./scipion config again. Read more about editing the configuration file.

The file config/hosts.conf contains some properties of the execution machine. This configuration file is particularly important for clusters that use a Queue System. If you are installing Scipion on a cluster, you probably will want to check how to configure an execution host.

Install (only required if installing from sources)

If you have downloaded the pre-compiled binary, you can skip this step and go to Installing other EM Packages section.

To compile and install Scipion, just run:

./scipion install -j 5

-j 5 tells the Scipion installer to use 5 processors (cores) for compilation. You should adjust this value according to your system.

By default, Scipion installs opencv and scipy, which are big libraries and are only used by few programs. It is possible skip the installation of opencv and scipy by using the --no-opencv and --no-scipy options. See ScipionBuildTimesDistribution for more details on how long each step of the installation takes. If you have problems compiling Scipion, see Troubleshooting page.

Installing other EM Packages

Scipion can use the following EM software packages: Xmipp3, Relion, Spider, Eman2.1, frealign, ctffind, Resmap, unblur and summovie, among others. You can see the up-to-date list of available packages with this command:

./scipion install --help

To install one of the packages from the list (by default, all packages are installed in software/em), run the install command with the name of the package. For example:

./scipion install --no-xmipp ctffind

You can also install multiple packages with a single install command:

./scipion install --no-xmipp bsoft ctffind ctffind4 eman2.12 frealign
or
./scipion install --no-xmipp -j 5 relion-1.4 relion-1.4_float resmap spider

Note: some EM packages may have extra requirements that needs to be installed or that you can use existing EM packages installations. For more information please check how to install EM packages.

Next Steps

  • Test your installation by running at least the Small and Medium tests mentioned in running tests page.

  • Update a previous installation (from git): git pull && ./scipion install -j 5. You will get the latest changes without installing everything that is already in place (like the external libraries and Python modules).

  • Complete some of the Scipion Tutorials.