Building EMAN2/SPARX/SPHIRE from Source

Standard instructions for establishing a build and runtime environment for EMAN/SPARX/SPHIRE on Linux, macOS and WSL2 (Windows):

WARNING FOR EXISTING USERS - If your last source build was before 8/21/24, on that date we updated the eman-dev conda-forge dependencies to use Python 3.12. This Python version has some backwards incompatibility, and using it requires setting up a fresh EMAN2 environment, or you will get a variety of errors. If you are in this situation:

While the instructions look long, in reality it should only take 10-15 minutes to complete the entire process (with a decent network connection).

Contents

  1. Initial Setup
  2. Build and Install: Daily development, Update code, etc.
  3. Test install
    1. Troubleshooting
  4. Reporting Problems
  5. Linux Clusters

Initial Setup

This section only needs to be completed once. If you have a working EMAN2 source installation and just wish to update, skip ahead to Build and Install.

  1. Check your account for possible problems

    • IF you have conda-forge (or Anaconda if you meet the licensing requirements) installed in your account already, and wish to try setting up EMAN2 as a new environment skip ahead to Configure and update conda. This may or may not work without some effort, depending on the age of your install.

    • Otherwise: 
       1 echo $PATH
   2 # make sure no Anaconda/Miniconda/old 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

  2. Download and install MiniForge: Installers (for your platform)

    • If your site has an Anaconda license, you are welcome to use the conda provided by a proper Anaconda/MiniConda installation. Using mini-forge, which provides 'conda' and 'mamba' command line tools is (at the time of writing) completely open-source. All EMAN2 dependencies are provided by conda-forge and make no use of the Anaconda mainline repository, so require no licensing agreement (as far as we can determine). 
       1 bash <MiniForge-installer>
   2 
   3 # There are a variety of options you can use, but the default command above is sufficient in most cases
   4 bash <MiniForge-installer> --help

    and follow the prompts. When you see Do you wish to update your shell profile to automatically initialize conda?, say no, then move on to the next step.

  3. 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 that into account: 

       1 # for bash-like shells, such as bash and zsh
   2 source <MiniForge-path>/etc/profile.d/conda.sh
   3 
   4 # for csh-like shells, such as csh and tcsh:
   5 source <MiniForge-path>/etc/profile.d/conda.csh
   6 
   7 # <shell-name> is bash, fish, powershell, tcsh, xonsh or zsh
   8 conda init <shell-name>

    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/.

  1. 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 conda config --set auto_update_conda False
   6 
   7 # If you have Anaconda, not miniforge, you may need to install mamba separately. If you used miniforge as described above, you should already have '''mamba'''
   8 conda install mamba -c conda-forge
   9 
  10 # Update base environment to get the latest conda
  11 mamba update --all -n base
  12 
  13 # Mac M1/M2/... users, if you get an error in the previous step see Troubleshooting below
  14

  2. 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 mamba create -n eman2 eman-dev --only-deps -c cryoem -c conda-forge

    To get the non-GUI variant which will not have pyqt and pyopengl, and can be installed on machines that do not provide GUI support and do not have any OpenGL packages installed, run one of the commands below: 

       1 mamba create -n eman2 'eman-dev=*=nogui_*' --only-deps -c cryoem -c conda-forge

    List of dependencies: If you wish to see the list of conda dependencies that eman-dev is built from, look here. Some of the dependency versions are listed in the appropriate file under .ci_support.

  3. 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.

  4. Get EMAN code from GitHub:cryoem/eman2. 

       1 cd <path-where-you-want-eman2-source>   # eg - $HOME/src
   2 git clone https://github.com/cryoem/eman2.git # this will create an eman2 folder containing the current source code from the master branch
   3

  5. Create a build directory (out-of-source builds are recommended). 

       1 mkdir <build-directory> # eg- $HOME/src/eman2-build
   2

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:

  1. Activate your environment. If you used a different name above, use it here too. 

       1 conda activate eman2

  2. 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  # get remote branches and cleanup non-existing remote branches from local repo
   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

  3. CMake 

       1 cd <build-directory>
   2 # on Mac:
   3 cmake <source-directory>   # - eg $HOME/src/eman2, optionally add -DCMAKE_VERBOSE_MAKEFILE
   4 
   5 # on Linux:
   6 cmake <source-directory> -DENABLE_OPTIMIZE_MACHINE=ON  # - eg $HOME/src/eman2, optionally add -DCMAKE_VERBOSE_MAKEFILE
   7

    • cmake-gui

      • 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.

    • ccmake

      • If you use ccmake, you may get an error related to OpenGL. If this happens try quitting ccmake and running it again.

  4. Make 

       1 make -j 8
   2 make install
   3 
   4 # To install sphire
   5 make install-sphire

    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.

Test install

Troubleshooting

Solutions to potential known problems will be listed here. If these don't help, please report your problem (http://groups.google.com/group/eman2):

Reporting Problems

Please, provide the output of the following commands when reporting a problem. Record the session via script command. This, also, records the commands. 

  1.    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

  2. Send filename.txt.

Linux Clusters

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.

EMAN2/Install/SourceInstall (last edited 2024-12-13 14:49:02 by SteveLudtke)