Skip to content

Latest commit

 

History

History
61 lines (46 loc) · 2.22 KB

INSTALL.rst

File metadata and controls

61 lines (46 loc) · 2.22 KB

Building TomoPy

Installing dependencies

To build and run TomoPy, you will need to install at least the dependencies listed in envs/{platform}-{version}.yml plus additional dependencies based on your platform. For convenience, installing requirements for building the Python 3.6 version on Linux can be accomplished as follows:

$ conda env create -f envs/linux-36.yml [-n ENVIRONMENT]

This will create a new conda environment named tomopy with the build dependencies. If you already have a conda environment named tomopy. Use the -n option to name it something else.

Additional Windows Requirements

The Windows VC++2017 compiler cannot be distributed through conda. The conda package for this compiler creates link from the system provided compiler to the conda environment into which it is installed. Install VC++2017 using the Windows Build Tools installer; Visual Studio (the IDE) is not required to build TomoPy.

Additional CUDA Requirements

The CUDA compiler cannot be distributed through conda. Building TomoPy with GPU features requires the CUDA Toolkit and NVCC.

Compiling TomoPy

TomoPy is built/packaged in two parts: the python-only modules and the compiled shared libraries. The python module searches the library path at import time for the compiled shared libraries and raises an error/warning if they are not located. Because the compiled and python parts are sepeparate, developing the python parts does not require building the compiled parts; the compiled parts may be installed precompiled using conda.

TomoPy (the python-only modules)

After navigating to inside the tomopy directory, you can install TomoPy by running the install script in the typical Python way:

$ pip install . --no-deps

libtomo (the compiled shared libraries)

The shared libraries are a CMake project which are installed in the typical way:

$ mkdir build
$ cd build
$ cmake .. -GNinja -DCMAKE_INSTALL_PREFIX=$CONDA_PREFIX -DCMAKE_INSTALL_LIBDIR=lib
$ cmake --build .
$ cmake --install .