Installation
Release builds
Stand-alone builds for Windows are provided for certain major releases and do not require the installation of additional software: https://github.com/jdber1/opendrop/releases/.
Releases for Linux and macOS don’t exist yet and OpenDrop should instead be installed as a Python package. See next section.
Building package from source
OpenDrop requires Python 3.6 or higher, the GTK 3 library, OpenCV Python bindings, and the following build dependencies:
Boost.Math
SUNDIALS ARKODE
Other required Python packages will be automatically installed by pip.
Platform specific build instructions follow.
Ubuntu
Install OpenCV.
If on Ubuntu 17.10 (or later):
sudo apt install python3-opencv
Alternatively there is an unofficial opencv-python package that can be installed using pip:
pip3 install opencv-python
Install SUNDIALS. Unfortunately
libsundials-dev
from the Ubuntu repositories are too old, we require at least version 4.0.0 and above. Here are brief instructions for installing SUNDIALS from source.Download the latest version from the releases page. (Note: the latest version requires a CMake version newer than available in Ubuntu < 20.04. If this affects you, try an older version of SUNDIALS like 4.0.0 instead.)
Extract and change into the source directory, e.g.:
tar -xvf sundials-5.7.0.tar.gz cd sundials-5.7.0/
Create a build directory:
mkdir build cd build/
Configure, build, and install (make sure
cmake
andbuild-essential
are installed from the Ubuntu repos):cmake \ -DEXAMPLES_INSTALL=OFF \ -DBUILD_ARKODE=ON \ -DBUILD_CVODE=OFF \ -DBUILD_CVODES=OFF \ -DBUILD_IDA=OFF \ -DBUILD_IDAS=OFF \ -DBUILD_KINSOL=OFF \ -DBUILD_STATIC_LIBS=OFF \ -DCMAKE_BUILD_TYPE=Release \ .. make sudo make install
Install Boost.Math. If on Ubuntu 20.04 or newer, run:
sudo apt install libboost-dev
The
libboost-dev
package on older versions of Ubuntu is not recent enough and Boost will need to be installed from source. We need at least Boost 1.71.0.Follow the installation instructions here for installing PyGObject and GTK.
Use pip to install OpenDrop from the repo:
pip3 install git+https://github.com/jdber1/opendrop.git
Run
pip3 uninstall opendrop
to uninstall.Run
python3 -m opendrop
to launch the app.
Fedora
Tested on Fedora 35.
Install Python, pip, and OpenCV:
sudo dnf install python3-devel python3-opencv python3-pip
Install glib:
sudo dnf install glib2-devel
Install SUNDIALS:
sudo dnf install sundials-devel
Install Boost:
sudo dnf install boost-devel
Use pip to install OpenDrop from the repo:
pip install git+https://github.com/jdber1/opendrop.git
Run
pip uninstall opendrop
to uninstall.Run
python -m opendrop
to launch the app.
macOS
Install the latest version of Python 3 and pip. You can do so using a third-party package manager like MacPorts or Homebrew.
Install the unofficial opencv-python package by running:
pip install opencv-python
(Make sure
pip
refers to your Python 3’s pip installation.)Alternatively, OpenCV and its python bindings can also be installed using the opencv Homebrew formula or opencv MacPorts port.
If Homebrew was used to install Python 3, PyGObject and GTK can also be installed by running:
brew install pygobject3 gtk+3
or if MacPorts was used, run:
sudo port install py36-gobject3 gtk3
(Instead of the
py36-
prefix, usepy37-
orpy38-
if Python 3.7/3.8 is the version installed.)
Install Boost.Math and SUNDIALS. (todo: Add MacPorts and Homebrew example).
Use pip to install OpenDrop from the repo:
pip install git+https://github.com/jdber1/opendrop.git
Run
pip uninstall opendrop
to uninstall.Run
python3 -m opendrop
to launch the app.
Windows
Installing OpenDrop as a Python package is possible on Windows using platforms like MSYS2 or Anaconda. The process is not very straightforward so your mileage may vary.