EMAN Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Binary Installation Instructions v2.91 ======

**//We do not recommend installing EMAN2.91. It is significantly out of date. Please follow the easier instructions for the newer version: //** [[eman2:install:sourceinstall|from source]] or [[eman2:install:condainstall|Binary]]

====== Download ======

  * [[https://cryoem.bcm.edu/cryoem/downloads/view_eman2_version/32|Download EMAN2.91]].

  * [[http://cryoem.bcm.edu/cryoem/downloads/view_eman2_versions|Download older EMAN2 versions]], instructions for older versions are [[https://blake.bcm.edu/emanwiki/EMAN2/Install#Binary_Installation_.28most_users_should_do_this.29|here]].

 Official releases are in reverse chronological order. The [[https://cryoem.bcm.edu/cryoem/downloads/view_eman2_version/25|Continuous Build]] is rebuilt daily and any time a developer makes a change they think users should have access to. It is normally reasonably stable, and will contain the latest pre-publication features. Alternatively, the highest numbered version will contain a stable and tested release.



====== Install ======


===== MacOS and Linux =====

The neural network code in EMAN2 works best on GPUs, which are available only on the Linux installations. It can still run on Mac, but will be quite slow.

 1. **Cleanup:** If you have previously installed EMAN2:
    * Please remove or rename any existing installed EMAN2 folder you might have.
    * Please remove any existing EMAN2 entries from PATH.
    * LD_LIBRARY_PATH, DYLD_LIBRARY_PATH, PYTHONPATH and PYTHONHOME are NO LONGER USED, and should be removed if you have them set.
    * If you have any of these shell variables set for use with other software, it may be necessary to remove those settings as well. If the tests below fail after installation, this is the first thing to check.
 2. **Download:** [[https://cryoem.bcm.edu/cryoem/downloads/view_eman2_version/32|Download EMAN2.91]]
 3. **Install:**
<code bash>
bash <path-to-EMAN2-installer>
</code>
    * You will be prompted for a location to install EMAN2. Note that you cannot rename this folder after installation! You must reinstall if you wish to move the installation.
    * You will be asked if you want to initialize EMAN2.
    * EMAN2 initialization will add a block of code to your //.profile/.bashrc// file. After initialization open your //.profile/.bashrc// file and confirm that a block like the following has been added

<code bash>
# >>> conda initialize >>>
# !! Contents within this block are managed by 'conda init' !!
...
...
...
unset __conda_setup
# <<< conda initialize <<<

</code>
  If you have any other similar looking blocks before the last one, remove them to avoid any potential conflicts.
    * If you use a different shell, such as tcsh or zsh, you may need to edit the appropriate file yourself.
    * You should not normally need to reinstall OpenMPI. The copy of OpenMPI/Pydusa now distributed with the binaries should work on Macs/Linux workstations in most cases.
    * Don't forget to restart your shell if you changed the .profile/.bashrc or other scripts.
    * **Mac users:** If you don't understand what the .profile instructions are talking about, this may help: https://stackoverflow.com/questions/7501678/set-environment-variables-on-mac-os-x-lion
 4. **Test:** Run these programs to see if the install worked:
<code bash>
e2version.py
e2speedtest.py
e2display.py
e2proc2d.py :64:64:1 test.hdf --process mask.sharp:outer_radius=24
e2display.py test.hdf
</code>

==== Notes ====

 5. **Linux users:** The new neural network based routines are much faster running on a GPU. If you have an NVidia graphics card, see [[#GPU|//Using the GPU//]] section below.
 6. **Mac users (Big Sur):** Big Sur (MacOS 11) includes new security features which require you to give software permission to access specific folders. This can cause problems for many open-source software packages launched from the command line. The easiest solution is Preferences -> Security & Privacy -> Privacy -> Full Disk Access, and give Terminal full access. This will not solve every problem, and you need to be aware of potential security risks in doing this, but for most scientific users it is a good solution.
 7. **Mac users (Apple Silicon, M1):** Anaconda does not yet fully support native M1 software, so you will need to install the normal Mac build. The installer will say that you appear not to be running on a 64 bit machine, and ask if you wish to install anyway. Say YES. Performance is excellent even though it isn't a native build.  
 8. Check continuous build sections, [[EMAN2:Install/BinaryInstallAnaconda#ContinuousBuild-Notes|Notes]] and [[EMAN2:Install/BinaryInstallAnaconda#ContinuousBuild-Troubleshooting|Troubleshooting]], which may contain more up-to-date info that may be relevant here.

==== Troubleshooting and Tips ====

  * If you receive an "Illegal Instruction" crash, this usually means your CPU isn't compatible with the binaries. If you see this on the 2.91 release and have a newer machine, try a daily snapshot. If still having issues, just [[EMAN2:COMPILE_EMAN2_ANACONDA|build from source]]. It's a lot easier than it sounds.
    * We try to be as compatible as possible when building the binaries without having a strong negative impact on performance, however, recently Intel has started disabling some of the older features on its newer chips (AVX). This means the 2.91 release binaries may not run on some of the newer intel machines. We have changed the compilation now, so current snapshot versions should be compatible with the latest processors, but will now only be backwards compatible to ~2014 machines.
  * If you get an error like the one below, dependency installation step might have failed. <code>
Traceback (most recent call last):
  File "/.../.../eman2/bin/e2proc3d.py", line 35, in <module>
    from past.utils import old_div
ModuleNotFoundError: No module named 'past'
</code>
 Run the dependency installation manually. <code>
conda install eman-deps=25 -c cryoem -c defaults -c conda-forge
</code>
  * If you have problems with any of the test programs, the first thing to check is whether you have PYTHONPATH, PYTHONHOME, LD_LIBRARY_PATH or DYLD_LIBRARY_PATH set in your shell. While used in previous versions of EMAN, variables are no longer used, and in some cases may interfere with Anaconda. If they are set to make some other software package work, but they interfere with the programs above, you will have to unset them, and set them only when you need the other software.
  * Specifically, if only the GUI fails and you are using an Nvidia graphics card, it is likely caused by a graphics card driver incompatibility. Updating the Nvidia driver usually fixes the problem. On recent Ubuntu systems, running //apt-get install nvidia-current// works. On other systems, you may need to follow the installation guide from Nvidia.
  * You will find that when you open a new shell, you will see (base) added to your command prompt. This indicates that Anaconda, the environment EMAN2 now uses for distribution, is active, and you can run EMAN2/SPARX/SPHIRE commands. 
    * If this causes issues for other software, you can type <code>conda deactivate</code> and EMAN2 commands will no longer work (but any software that doesn't like Anaconda will work).
    * Alternatively, you can type <code>conda config --set auto_activate_base False</code>, which will prevent Anaconda from being activated automatically when you open new shells. In that case you will need to do a <code>conda activate</code> before running EMAN2/SPARX/SPHIRE commands.
  * Check continuous build sections, [[EMAN2:Install/BinaryInstallAnaconda#ContinuousBuild-Notes|Notes]] and [[EMAN2:Install/BinaryInstallAnaconda#ContinuousBuild-Troubleshooting|Troubleshooting]], which may contain more up-to-date info that may be relevant here.

===== Windows =====
While we do provide 64 bit Windows binaries for EMAN2, some functionality may be broken, so we strongly recommend using the [[#Windows-WSL]] option below if at all possible. 

Notes for native Windows version:
  * SPARX/SPHIRE are not supported.
  * EMAN2 functionality may not be complete. You will get more complete functionality using the Linux/Bash shell approach below.
  * Even for the main EMAN2 programs, native Windows support remains somewhat marginal, and is provided primarily for utility functions and basic GUI tools, like micrograph evaluation and particle picking. You are welcome to ask questions in the mailing list, but there may be limited help we can provide because we simply don't have Windows machines around for testing.

==== Native Win7/10 64 bit ====
 9. Download [[https://cryoem.bcm.edu/cryoem/downloads/view_eman2_version/32|Download EMAN2.91]].
 10. Launch the installer.
  11. **Select Installation Type:** Just Me
  12. **Choose Installation Location:** Select a location with NO space in path
  13. **Advanced Installation Options:** Don't add EMAN2 to PATH environment variable.
 14. Open Anaconda Prompt by clicking Windows **Start Menu -> Anaconda3 (64-bit) -> Anaconda Prompt** or **Start Menu -> Anaconda3 (64-bit) -> Anaconda Prompt(installation-folder-name)**.
 15. In most cases you will want to install: [[https://bitbucket.org/vinay.sajip/pylauncher/downloads/|Python Launcher]]  ([[https://bitbucket.org/vinay.sajip/pylauncher/downloads/launchwin-1.0.1.6.msi|launchwin-1.0.1.6.msi]]).
 16. Run these programs to see if the install worked:
<code>
e2version.py
e2speedtest.py
e2display.py
e2proc2d.py :64:64:1 test.hdf --process mask.sharp:outer_radius=24
</code>


<<Anchor(Windows-WSL)>>
==== Windows 10 - Linux/Bash shell (As of 12/15/2020) ====
Windows 10 includes an embedded Ubuntu Linux environment. It is possible to run the EMAN2 **Linux binaries** within this Win10 environment, but you will need to install some additional dependencies to do so. Also, you will effectively be running at a Linux command prompt, so you will have to become a bit familiar with Linux to do this, but it does avoid installing an additional operating system on your machine.

<code>#!wiki note
https://docs.microsoft.com/en-us/windows/wsl/install-win10.
</code>

 17. Click "Start" and type "Turn Windows Features on or off".
      * Enable "Windows Subsystem for Linux".
      * Enable "Virtual Machine Platform".

 {{http://blake.bcm.edu/dl/EMAN2/Windows Features.png||width=600}}

 18. Install Ubuntu from "Microsoft Store".

 {{http://blake.bcm.edu/dl/EMAN2/Windows Store - Ubuntu.png||width=600}}

 19. Run "Ubuntu" from Start Menu.

 20. Install OpenGL.
<code bash>
sudo apt update
sudo apt install libsm-dev libxrender-dev build-essential libgl1-mesa-dev mesa-utils mesa-common-dev libglu1-mesa libglu1-mesa-dev mesa-utils
sudo apt autoremove
</code>

 21. Install [[https://sourceforge.net/projects/xming/|Xming X Server for Windows]].
    * Don't forget the fonts and Mesa (OpenGL) modules! If it seems to work, but the letters are black boxes, or you have other visual artifacts, the problem is probably with OpenGL support.

 22. Download and install LINUX binary, not windows binary! [[https://cryoem.bcm.edu/cryoem/downloads/view_eman2_version/32|Download EMAN2.91]], [[#Linux]].
Make sure to follow the instructions for shell initialization using `conda-init`.

 23. Start X Server and set environment variables.
<code bash>
export DISPLAY=:0
glxinfo | grep OpenGL
</code>

 {{http://blake.bcm.edu/dl/EMAN2/OpenGL output.png||width=700}}


 24. Run these programs to see if the install worked:
<code>#!highlight bash
e2version.py
e2speedtest.py
e2display.py
e2proc2d.py :64:64:1 test.hdf --process mask.sharp:outer_radius=24
</code>

 {{http://blake.bcm.edu/dl/EMAN2/Windows e2display.png||width=700}}



<<Anchor(GPU)>>

====== Using the GPU (Linux only) ======
Currently, the GPU is only used for neural network operations in tomogram annotation and in particle picking. It provides a ~10 fold or more speed up in neural network training. The new GPU developments are currently based on [[http://www.tensorflow.org|TensorFlow]]. From about 2006-2012 EMAN2 had its own internal CUDA code, which could be compiled into the C++ library. This has been deprecated, and likely no longer works, though the code is still present. We are working on a new GPU support strategy moving forward.

Many machines will have CUDA installed already, and if CUDA is an appropriate version, this should work fine with the !TensorFlow version shipped with EMAN2. However, if you are running newer versions of CUDA there may be problems. You can test compatibility quickly with:
<code>
# Make sure you have your environment set to run EMAN2 programs
e2version.py
# The above command should work and return your current version. If it does, then run:
python -c "import tensorflow"
</code>

If this command does not return an error, then you should be able to run deep learning software within EMAN2. If it does raise an error, then you will need to debug the problem:

  * If you do not have CUDA installed at all (and you are on a Linux machine with an NVidia GPU):
      * Installation depends on linux distribution, try your package manager for CUDA and/or CUDA-toolkit, for example, on Ubuntu 16.10:

<code>
apt-get install nvidia-cuda-toolkit
</code>
  * If the version of CUDA you have installed is incomparible, then you will need to get a compatible tensorflow installed in your Anaconda environment. Here is one possible suggestion:
<code>
conda remove tensorflow-gpu tensorflow-gpu-base
pip install cython
pip install tensorflow
# read any messages carefully, if there are errors you may need other installations
</code>
<code>
[dnn]
enabled=False
</code>

 . If you get a very long string of errors a few seconds after trying to train a network, and see references to "narrowing" in the errors, this probably means your C++ compiler is newer than Theano expects. You can try adding the following to your .theanorc file:
<code>
[gcc]
cxxflags = -Wno-narrowing
</code>