Installing optimap¶
optimap is available for Windows, Mac OSX, and Linux.
optimap requires Python 3.8 or later. To install Python we recommend installing the Anaconda distribution, which includes Python and many useful packages for scientific computing, or by installing Python directly.
Tip
optimap relies heavily on NumPy and Matplotlib. We recommend the Scientific Python Lectures and the Python Data Science Handbook for an introduction to Python and these libraries.
Warning
This Installation Guide is currently work in progress. We will add more information soon.
Installing optimap on Windows¶
Installing optimap on Windows requires Python, Numpy and matplotlib to be installed on the system.
Installing optimap on Mac OSX¶
Installing optimap on Mac OSX requires Python, Numpy and matplotlib to be installed on the system. On Mac OSX, Homebrew is a popular and very useful, freely available package manager with which one can install Python, Numpy and matplotlib. Paste and execute the following command in the Mac OSX terminal to install Homebrew: /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)". Note that Mac OSX has a native Python version installed and it is necessary to install a separate Python 3.8 version or later. Next, you need to install pip, which is a package installer specifically for Python packages. You can install pip using Homebrew: brew install pip. You can then use pip to install optimap:
pip install opticalmapping[all]
Installing optimap on Linux¶
With pip and Python already installed it is very straight-forward to install optimap on Linux systems:
pip install opticalmapping[all]
This will install the core functionality of optimap. However, the OpenCV and dependencies are not installed by default which are required for the optimap.motion and optimap.video modules. To install these dependencies use pip install opticalmapping[all] or install OpenCV manually.
If this command fails, please try the following:
python -m pip install opticalmapping\[all\]
Note
pip install opticalmapping will install the core functionality of optimap. However, the OpenCV and dependencies are not installed by default which are required for the optimap.motion and optimap.video modules. To install these dependencies use pip install opticalmapping[all] or install OpenCV manually.
To use GPU-accelerated motion tracking algorithms a CUDA-enabled version of OpenCV is required, which is currently not available on PyPI. See OpenCV with CUDA support for more information.
To update optimap to the latest version run pip install --upgrade opticalmapping[all]. See Contributing for instructions on how to install optimap from source.
GPU Acceleration¶
By default, optimap will be installed without GPU-acceleration (graphics processing unit).