Building EMAN2/SPARX/SPHIRE from Source
Standard instructions for establishing a build and runtime environment for EMAN/SPARX/SPHIRE on Linux and macOS
- While the instructions look long, in reality it should only take 10-15 minutes to complete the entire process (with a decent network connection).
We use Conda for a working environment and most of the dependencies. Anaconda distribution has become ubiquitous for Python and R-based scientific computing and education over the last decade. While it may be possible to build the system without using Conda, we do not recommend doing this, and cannot provide support for a non-conda approach. If you follow the instructions below, you should have a painless source build very quickly.
We make use of the environment system in conda, the package manager, to isolate EMAN2 dependencies from other conda packages you may have installed. If you need to install other packages you wish to use in concert with EMAN2, you will need to install them within the EMAN2 environment. Be warned that sometimes installing another package may trigger a version change in one of EMAN2's dependencies, which may or may not be a problem, depending on which dependency it is. We strongly suggest getting the base EMAN2 installed and working first, before trying to install any additional packages within the same conda environment.
- Note that even with a source build it may be difficult to get this working on systems with very old operating system installs. We normally try to support OS versions as much as 5-7 years old. Please report any problems.
GPU Support (Linux Only!): For features which support the GPU, please complete the standard source install instructions below, then follow the GPU instructions from the binary installation page.
Initial Setup (one time)
Remove/disable other Anaconda/Miniconda/EMAN installations. If you do not have Anaconda/Miniconda (or another copy of EMAN2/SPARX/SPHIRE) already installed in your account, skip to step 2. If you DO have Anaconda or Miniconda installed in your account, you must ensure that any existing install you have is not active in your shell (not in PATH, no LD_LIBRARY_PATH, PYTHONPATH or PYTHONHOME set). While it may also be possible to set up an environment for EMAN2 in your existing Anaconda install, you will need to know what you're doing, and adapt these instructions to your situation.
1 echo $PATH 2 # make sure no Anaconda/Miniconda/EMAN2 entries 3 echo $LD_LIBRARY_PATH 4 echo $PYTHONPATH 5 # ideally, both return nothing. If it set to something it is possible that it may interfere with Anaconda 6 # strongly suggest at least during the install, ''unset'' both of these. After installation you can test 7 # to see if they cause any issues 8
and follow the prompts. When you see Do you wish the installer to initialize Miniconda3 by running conda init?, say no, then move on to the next step.
Initialize conda for shell interaction. These instructions will depend on what shell you use. The default on most systems is bash. If you use a different shell ( tsch, zsh, ... ), you will need to take this into account:
As it says after you run this command, you will need to close and reopen your shell/terminal for it to take effect. This command modified your shell initialization so the conda activate command can be used properly. For more information on conda-init and activation, see Environment Activation.
macOS Users (bash only)
On macOS, this modifies ~/.bash_profile. If you have a ~/.profile startup file, creation of ~/.bash_profile will prevent ~/.profile from being read. A simple solution is to source .profile within .bash_profile.
For differences between login- and non-login shells and order of reading the startup files on macOS, see, https://www.anintegratedworld.com/basics-of-osx-bashrc-v-profile-v-bash_profile/.
Configure and update conda.
1 # We suggest the following, meaning you will need to use ''conda activate'' after logging in before using EMAN2 2 conda config --set auto_activate_base False 3 4 # Automatic conda updates may cause things to break, so we suggest making all package upgrades explicitly 5 # The current version verified to work with EMAN is '''conda 4.9.1''' 6 conda config --set auto_update_conda False 7 8 # Flexible channel priority works better for eman-deps 9 conda config --set channel_priority flexible 10 11 # Update base environment to get the latest conda 12 conda update --all -n base
Create a new environment with EMAN2 dependencies. eman2 below is the name of the environment. You may make this whatever you like, as long as you remember to use the same name when doing conda activate. Note that this name will appear as part of your prompt when activated, so you may want to keep it short.
1 conda create -n eman2 eman-deps=26 -c cryoem -c defaults -c conda-forge
If you wish to see the list of conda dependencies that eman-deps is built from, look here.
macOS Big Sur Users
The new Big Sur macOS release (fall 2020) broke some things in Python, which are only now (Dec 2020) getting fixed. These fixes have not yet made their way into Anaconda. If you experience an error similar to "Unable to load OpenGL library", install a patched pyopengl package from cryoem channel (as of 1/13/2021).
conda install pyopengl -c cryoem
This quick fix seems to provide a temporary solution until Anaconda gets the necessary updates:
You need to go into your miniconda3 or anaconda3 folder and find this file (the path may be slightly different on your install, but you should be able to find it):
Around line 80 you should find a line like:
fullName = util.find_library( name )
change this line to:
fullName = '/System/Library/Frameworks/' + name + '.framework/' + name
(important to use 8 spaces before fullName, not a <tab>)
Ensure you have OpenGL:
EMAN2 uses OpenGL (via PyQt) for all of its graphics. OpenGL installation depends on OS variant and, for example, whether you are using proprietary NVidia drivers under Linux. You will need to have OpenGL set up on your machine as a whole before continuing. On Mac, you should already have this with XCode. On Linux with an NVidia driver you will likely also need to install the Mesa header files. If you aren't sure how to set up OpenGL, Google can probably help.
Get EMAN code from GitHub:cryoem/eman2.
Create a build directory (out-of-source builds are recommended).
Build and Install: Daily development, Update code, etc.
When you start a new shell, these are the steps you will need to take before running EMAN programs or compiling the system:
Activate your environment. If you used a different name above, use it here too.
1 conda activate eman2
Update and Checkout source code. Periodically you should update your source using standard git techniques.
1 cd <source-directory> # <path-where-you-want-eman2-source>/eman2 2 git fetch --all --prune # optional cleanup of local files 3 git checkout master # to make sure you are building from the current master build rather than a branch someone is working on 4 git pull # This is what actually updates your local copy of the code 5
If you use cmake-gui, since conda is not in PATH anymore, cmake will fail to find the environment directory. In that case set CONDA_PREFIX to your conda environment directory manually.
- Make sure to delete any cmake variables that cmake already found, variables like *_LIBRARY or similar, *_INCLUDE_PATH or similar, CONDA_EXECUTABLE, CMAKE_INSTALL_PREFIX and any variables that are expected to contain conda environment related values.
- Configure and generate.
If you use ccmake, you may get an error related to OpenGL. If this happens try quitting ccmake and running it again.
Note that the make -j 8 above will compile using 8 threads. On some machines omitting the 8 will compile faster and cause no problems, and if you have more than 8 threads on your machine, you can increase the number.
Other Environments. To switch to another conda environment (stop working with EMAN2), first deactivate your current environment.
1 conda deactivate
For debugging and reporting, see Debugging and Reporting.
Debugging and Reporting
Please, provide the output of the following commands when reporting a problem. Record the session via script command. This, also, records the commands.
1 script filename.txt 2 3 conda activate eman2 4 5 conda info -a 6 conda list 7 conda list --explicit 8 9 cd <source-dir> 10 11 git status 12 git log -1 13 14 cd <build-dir> 15 16 rm CMakeCache.txt 17 cmake <source-dir> 18 cmake . -LA 19 20 make clean 21 make -j 22 make install 23 make test-verbose 24 25 conda deactivate 26 27 exit # or Ctrl+D 28
The approach above will install EMAN with a precompiled version of OpenMPI, which may or may not work with the batch queuing system on your cluster. If it does not work, the symptom will be that MPI parallel jobs will use only a single node, no matter how many you have allocated in your job. Currently, we do not have alternative OpenMPI installation instructions.