Skip to content

Latest commit

 

History

History
187 lines (145 loc) · 5.28 KB

README.build.mac.md

File metadata and controls

187 lines (145 loc) · 5.28 KB
Raw

Build morphologica on Apple Mac

You don't need to build morphologica to use the headers, but you will need to install the dependencies.

The cmake-driven morphologica build process compiles a set of test and example programs which require all of the dependencies to be met.

Programs that #include morphologica headers will also need to link to some or all of those dependencies. Finally, you'll need the cmake program and a C++ compiler which can compile c++-17 code.

Installation dependencies for Mac

You will need XCode from the App Store. If you just installed XCode, then you'll need to agree to its licence terms. To do this, run

sudo xcodebuild -license

scroll through the legalese and type 'agree' (assuming that you do). Also, do make sure to run XCode at least once from the launcher as this will prompt it to download and install some additional components. Finally, it seems to be necessary to "install command line tools" to get a working compiler. To do so (at least on MacOS Catalina):

xcode-select --install

Installation of most of the other dependencies can be achieved using Mac ports (Option 1, below). This does lead to the installation of a great deal of additional software, some of which can conflict with Mac system software (that's libiconv, in particular). However, a clean install of Mac ports will successfully install the dependencies for morphologica.

I'd advise you to use Option 1: Mac Ports only if you already use Mac Ports, other wise, prefer Option 2: Manual dependency builds.

Option 1: Mac Ports

Install Mac ports, following the instructions on http://www.macports.org/. This will guide you to install the XCode command line tools, then install the Mac ports installation package.

Finally, use Mac ports to install the rest of the dependencies:

sudo port install cmake armadillo

Be aware that if you have conflicting versions of any of the libraries in another location (such as /usr/local), you may run into problems during the build.

Now skip Option 2 and go to Common manual dependency builds to compile glfw3 by hand.

Option 2: Manual dependency builds

It's much cleaner to build each of the dependencies by hand. That means first installing cmake, which I do with a binary package from https://cmake.org/download/, and then compiling hdf5 and armadillo (all of which support a cmake build process).

After downloading and installing cmake using the MacOS installer, I add these lines to ~/.zprofile so that I can type cmake at the terminal:

# Add cmake bin directory to path so you can type 'cmake'
export PATH="/Applications/CMake.app/Contents/bin:${PATH}"

Armadillo

Armadillo is a library for matrix manipulation. The only place it's used in morphologica is within the Bezier curve code, morph::BezCurve. This code is used in the morph::HexGrid classes. If your programs won't use Bezier curve code, then you don't need Armadillo. It is required to compile many of morphologica's test programs though.

Download a package - I downloaded armadillo-9.900.3.tar.xz, though older versions back to 8.400.0 should work.

mkdir -p ~/src
cd ~/src
tar xvf path/to/downloaded/armadillo-9.900.3.tar.xz
cd armadillo-9.900.3
mkdir build
cd build
cmake ..
# or optionally: cmake -DCMAKE_INSTALL_PREFIX=/usr/local -DCMAKE_OSX_DEPLOYMENT_TARGET=10.14
# which will set the install locn and get the code compiled for targets as old as mac 10.14
make
sudo make install

HDF5

Hierarchical data format is a standard format for saving binary data. morph::HdfData wraps the HDF5 API and hence HDF5 is a required dependency to build all of the morphologica tests and is required if you are going to use morph::HdfData. Build version 1.10.x.

mkdir -p ~/src
cd ~/src
tar xvf path/to/downloaded/hdf5-1.10.7.tar.gz
cd hdf5-1.10.7
mkdir build
cd build
cmake ..
make
sudo make install

OpenCV

Optional. Computer vision code. ONLY used in the class morph::HdfDataCV, which is OpenCV-aware (and can save cv::Points and cv::Mats). I compiled OpenCV master from git. That probably corresponded to version 4.4.0. OpenCV versions as old as 3.2.0 also work.

mkdir -p ~/src
cd ~/src
git clone [email protected]:opencv/opencv.git
cd opencv
mkdir build
cd build
cmake ..
make
sudo make install

Qt5

If present, the Qt5 components Core, Gui and Widgets components are used to compile some example Qt morphologica programs. I've not tested this on Mac.

Common manual dependency builds

Whether or not you used mac ports to install hdf5 and armadillo, glfw3 also needs to be built separately (I've not investigated whether there is a mac ports version of glfw).

glfw3

The modern OpenGL code in morphologica requires the GL-window managing library GLFW3. Compile it like this:

cd ~/src
git clone https://github.com/glfw/glfw.git
cd glfw
mkdir build
cd build
cmake ..
make
sudo make install

Build morphologica on Mac

To build morphologica itself, it's the usual CMake process:

cd ~/src
git clone https://github.com/ABRG-Models/morphologica.git
cd morphologica
mkdir build
cd build
# If you have doxygen, you can build the docs with -DBUILD_DOC=1.
# If you have OpenMP, you can add -DCOMPILE_WITH_OPENMP=1
cmake ..
make -j$(nproc)
sudo make install

Tests

To run the test suite, use the ctest command in the build directory.