Differences between revisions 30 and 87 (spanning 57 versions)
⇤ ← Revision 30 as of 2017-06-10 05:50:45 →
Size: 1717
Editor: TunayDurmaz
Comment:
← Revision 87 as of 2019-05-27 13:01:28 → ⇥
Size: 6661
Editor: TunayDurmaz
Comment: add link to dependencies list
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
= !!! UNDER CONSTRUCTION !!! = = Anaconda based Build, All Platforms =
These instructions are for building with '''!NumPy v1.13'''.
Line 3: Line 4:
= All platforms = EMAN2 source lives on GitHub, downloading the source is part of the instructions below. Since EMAN2 uses Anaconda for its base environment, please follow the instructions below for a painless compile from source. If you go 'off script' you're on your own!
Line 5: Line 6:
The following instructions will work with cmake changes introduced in https://github.com/cryoem/eman2/pull/65. 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 ==
For features which support the GPU, please complete the source install instructions below, then follow the [[EMAN2/Install/BinaryInstallAnaconda#GPU|GPU instructions]] from the binary installation page.
Line 8: Line 12:
There are two approaches you can use for the installation. One uses 'Miniconda' and the other uses full 'Anaconda'. Miniconda is a much smaller (~30 MB) install, provides everything EMAN2 needs, and can be expanded with more packages as you like. Anaconda is a much more complete environment (~300 MB), including useful tools such as the Jupyter notebook, but will require the use of a conda environment to make EMAN2 work properly at present.
Line 9: Line 14:
 1. Download and install [[https://www.continuum.io/downloads | Anaconda2]] or [[https://conda.io/miniconda.html | Miniconda2]]. === Linux Clusters ===
The approaches below will install EMAN2 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. If this happens please see the linux cluster installations on the [[EMAN2/Install/BinaryInstallAnaconda|binary install page]]. Those instructions should also work with either of the source-based installations below.
Line 11: Line 17:
 1. Checkout EMAN2 code from [[https://github.com/cryoem/eman2 | GitHub:cryoem/eman2]]. {{{

cd <some-path-to-keep-eman2-source>
git clone https://github.com/cryoem/eman2.git		 === Miniconda2 ===
 1. Download and install '''Miniconda2-4.4.10''' for [[https://repo.continuum.io/miniconda/Miniconda2-4.4.10-Linux-x86_64.sh|Linux]] or [[https://repo.continuum.io/miniconda/Miniconda2-4.4.10-MacOSX-x86_64.sh|Mac OSX]].
  1. For existing installations install conda 4.5.
  {{{
conda install "conda>=4.5.2" -c defaults
Line 17: Line 24:
 1. Optionally, activate an existing conda environment, e.g. `source activate eman-env`. Skip this step, if you don't understand this statement. However, if you already use anaconda, you may get package conflicts when you install eman dependencies in the next step. In that case, you need to install eman and its dependencies in its conda environment.  1. Make sure that you have added '''miniconda2/bin''' as the '''first element''' in your '''PATH''', and that you do not have '''LD_LIBRARY_PATH''' or '''PYTHONPATH''' set in your shell. If you need these settings for other software, you can still try to proceed, and hope they do not conflict with Miniconda. Alternatively, you may set up a shell script or alias to make these environment changes on demand when you want to use EMAN2/miniconda.
Line 19: Line 26:
 1. Install dependencies {{{
conda install eman-deps -c cryoem -c defaults -c conda-forge
}}} Listing the channels explicitly can be avoided by specifying them in $HOME/.condarc, see conda documentation for more details, https://conda.io/docs/using/index.html.		  1. '''Install [[https://github.com/cryoem/eman-deps-feedstock/blob/0a4718059822ff88bd5778249f4bdb7555e5175f/recipe/meta.yaml#L11-L41|dependencies]]'''
 {{{
conda install cmake=3.9 -c defaults
conda install eman-deps=14 -c cryoem -c defaults -c conda-forge
}}}
Line 23: Line 32:
 1. Out-of-source builds are recommended, so work in a directory outside of eman2 source (this is generally true, not EMAN2-specific). Note '''cmake''', not '''--( ccmake )--'''. CMake will automatically find the dependencies. If you want to change any of the CMake values, then use '''cmake-gui''' or '''ccmake'''. {{{  1. '''Checkout EMAN2 code''' from [[https://github.com/cryoem/eman2|GitHub:cryoem/eman2]].
 {{{
cd <path-where-you-want-eman2-source> # eg - $HOME/src
git clone https://github.com/cryoem/eman2.git
# this will create an eman2 folder containing the current source code from the master branch
}}}
Line 25: Line 39:
 1. '''Create a build directory''' (out-of-source builds are recommended).
 {{{
mkdir <build-directory> # eg- $HOME/src/eman2-build
Line 26: Line 43:
cmake <some-path-to-keep-eman2-source> -DENABLE_CONDA=ON
make -j # "make" should pick up the number of available processors,
make -j4 # but you may specify the number if you like		 cmake <path-to-eman2-source> # - eg $HOME/src/eman2. On linux, also add -DENABLE_OPTIMIZE_MACHINE=ON
}}}
  * If conda is not found in PATH, set CONDA_PREFIX to your conda environment directory. It could be the main installation or an environment. This step most likely will be needed only if you use '''cmake-gui'''.
   * If you set CONDA_PREFIX to an environment, make sure to delete any cmake variables that cmake already found, variables like *_LIBRARY or similar, *_INCLUDE_PATH or similar.
   * Rerun cmake.

 1. '''Build EMAN2'''
 {{{
make -j
Line 32: Line 55:
 1. You may also wish to run
 {{{
make test # if everything passes you are fine, if there are failures, you are welcome to ask
make test-verbose # verbose test output to help to identify specific failures
}}}
Line 33: Line 61:
== Windows == === Anaconda2 ===

 1. Download and install '''Anaconda2-5.1.0''' for [[https://repo.continuum.io/archive/Anaconda2-5.1.0-Linux-x86_64.sh|Linux]] or [[https://repo.continuum.io/archive/Anaconda2-5.1.0-MacOSX-x86_64.sh|Mac OSX]].
  1. For existing installations install conda 4.5.
  {{{
conda install "conda>=4.5.2" -c defaults
}}}

 1. Make sure that you have added '''anaconda2/bin''' as the '''first element''' in your '''PATH''', and that you do not have '''LD_LIBRARY_PATH''' or '''PYTHONPATH''' set in your shell. If you need these settings for other software, you can still try to proceed, and hope they do not conflict with Anaconda. Alternatively, you may set up a shell script or alias to make these environment changes on demand when you want to use EMAN2/anaconda.

 1. '''Install [[https://github.com/cryoem/eman-deps-feedstock/blob/0a4718059822ff88bd5778249f4bdb7555e5175f/recipe/meta.yaml#L11-L41|dependencies]]'''
 {{{
conda create -n eman-env cmake=3.9 -c defaults
conda install -n eman-env eman-deps=14 -c cryoem -c defaults -c conda-forge

source activate eman-env
}}}

 1. Note that you will need to run {{{ source activate eman-env }}} once in each shell before being able to run EMAN2 commands.

 1. '''Checkout EMAN2 code''' from [[https://github.com/cryoem/eman2|GitHub:cryoem/eman2]].
 {{{
cd <path-where-you-want-eman2-source> # eg - $HOME/src
git clone https://github.com/cryoem/eman2.git
# this will create an eman2 folder containing the current source code from the master branch
}}}

 1. '''Create a build directory''' (out-of-source builds are recommended).
 {{{
mkdir <build-directory> # eg- $HOME/src/eman2-build
cd <build-directory>
cmake <path-to-eman2-source> # - eg $HOME/src/eman2. On linux, also add -DENABLE_OPTIMIZE_MACHINE=ON
}}}
  * If conda is not found in PATH, set CONDA_PREFIX to your conda environment directory. It could be the main installation or an environment. This step most likely will be needed only if you use '''cmake-gui'''.
   * If you set CONDA_PREFIX to an environment, make sure to delete any cmake variables that cmake already found, variables like *_LIBRARY or similar, *_INCLUDE_PATH or similar.
   * Rerun cmake.

 1. '''Build EMAN2'''
 {{{
make -j
make install
}}}

 1. You may also wish to run
 {{{
make test # if everything passes you are fine, if there are failures, you are welcome to ask
make test-verbose # verbose test output to help to identify specific failures
}}}

Anaconda based Build, All Platforms

These instructions are for building with NumPy v1.13.

EMAN2 source lives on GitHub, downloading the source is part of the instructions below. Since EMAN2 uses Anaconda for its base environment, please follow the instructions below for a painless compile from source. If you go 'off script' you're on your own!

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

For features which support the GPU, please complete the source install instructions below, then follow the GPU instructions from the binary installation page.

Mac OS X, Linux

There are two approaches you can use for the installation. One uses 'Miniconda' and the other uses full 'Anaconda'. Miniconda is a much smaller (~30 MB) install, provides everything EMAN2 needs, and can be expanded with more packages as you like. Anaconda is a much more complete environment (~300 MB), including useful tools such as the Jupyter notebook, but will require the use of a conda environment to make EMAN2 work properly at present.

Linux Clusters

The approaches below will install EMAN2 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. If this happens please see the linux cluster installations on the binary install page. Those instructions should also work with either of the source-based installations below.

Miniconda2

  1. Download and install Miniconda2-4.4.10 for Linux or Mac OSX.

    1. For existing installations install conda 4.5. 
      conda install "conda>=4.5.2" -c defaults

  2. Make sure that you have added miniconda2/bin as the first element in your PATH, and that you do not have LD_LIBRARY_PATH or PYTHONPATH set in your shell. If you need these settings for other software, you can still try to proceed, and hope they do not conflict with Miniconda. Alternatively, you may set up a shell script or alias to make these environment changes on demand when you want to use EMAN2/miniconda.

  3. Install dependencies 

    conda install cmake=3.9 -c defaults
conda install eman-deps=14 -c cryoem -c defaults -c conda-forge

  4. Checkout EMAN2 code from GitHub:cryoem/eman2. 

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

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

    mkdir <build-directory> # eg- $HOME/src/eman2-build
cd <build-directory>
cmake <path-to-eman2-source>   # - eg $HOME/src/eman2. On linux, also add -DENABLE_OPTIMIZE_MACHINE=ON

    • If conda is not found in PATH, set CONDA_PREFIX to your conda environment directory. It could be the main installation or an environment. This step most likely will be needed only if you use cmake-gui.

      • If you set CONDA_PREFIX to an environment, make sure to delete any cmake variables that cmake already found, variables like *_LIBRARY or similar, *_INCLUDE_PATH or similar.
      • Rerun cmake.

  6. Build EMAN2 

    make -j
make install
  7. You may also wish to run 
    make test          # if everything passes you are fine, if there are failures, you are welcome to ask
make test-verbose  # verbose test output to help to identify specific failures

Anaconda2

  1. Download and install Anaconda2-5.1.0 for Linux or Mac OSX.

    1. For existing installations install conda 4.5. 
      conda install "conda>=4.5.2" -c defaults

  2. Make sure that you have added anaconda2/bin as the first element in your PATH, and that you do not have LD_LIBRARY_PATH or PYTHONPATH set in your shell. If you need these settings for other software, you can still try to proceed, and hope they do not conflict with Anaconda. Alternatively, you may set up a shell script or alias to make these environment changes on demand when you want to use EMAN2/anaconda.

  3. Install dependencies 

    conda create -n eman-env cmake=3.9 -c defaults
conda install -n eman-env eman-deps=14 -c cryoem -c defaults -c conda-forge

source activate eman-env

  4. Note that you will need to run  source activate eman-env  once in each shell before being able to run EMAN2 commands.

  5. Checkout EMAN2 code from GitHub:cryoem/eman2. 

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

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

    mkdir <build-directory> # eg- $HOME/src/eman2-build
cd <build-directory>
cmake <path-to-eman2-source>   # - eg $HOME/src/eman2. On linux, also add -DENABLE_OPTIMIZE_MACHINE=ON

    • If conda is not found in PATH, set CONDA_PREFIX to your conda environment directory. It could be the main installation or an environment. This step most likely will be needed only if you use cmake-gui.

      • If you set CONDA_PREFIX to an environment, make sure to delete any cmake variables that cmake already found, variables like *_LIBRARY or similar, *_INCLUDE_PATH or similar.
      • Rerun cmake.

  7. Build EMAN2 

    make -j
make install
  8. You may also wish to run 
    make test          # if everything passes you are fine, if there are failures, you are welcome to ask
make test-verbose  # verbose test output to help to identify specific failures

EMAN2/COMPILE_EMAN2_ANACONDA-PRE-CONDA-ENVIRONMENTS (last edited 2019-11-01 14:27:54 by TunayDurmaz)