This guide is for those wanting to use Underworld from its source code - i.e. NOT under the docker environment ( see the previous post ).
Here we will use the
homebrew package manager to install most of the compiled packages and then use
pip to install the python dependencies.
Everything other than the installation of Xcode requires access to the terminal.
1) Install/Update Xcode with command-line tools
(From app store)
Run it once to accept the license, then quit To install xcode command-line tools go to a terminal and run
2) Install/Update homebrew
If this is a machine that is being upgraded from a previous major release of the OS then it is safest to start afresh with the homebrew packages as it seems difficult to ensure that all of the dependencies are properly managed across the upgrade.
If this is a brand new machine or a clean installation of the OS, a version of
homebrew will need to be installed.
To install homebrew.
Now, to check if there is anything on the system that needs fixing before moving on to install packages, run and follow its advice:
See here for further details the homebrew package manager.
3) Install dependencies via homebrew
homebrew to install the following packages
(Some of these have many dependencies of their own so this can take several minutes )
Add an environment variable to point to the (proxy) petsc installation. Most likely you’ll want this in your ~/.profile shell script.
Again check if homebrew is in order.
4) Install python dependencies via pip
For python dependencies we recommend using virtualenv to cleanly isolate Underworld2 dependencies from your system’s python packages. This is
NOT required but is our practice for development.
The following initialises a virtualenv called
venv in the current directory and activates it. If it was successful your prompt prefix will have changed to
Tip - to exit the virtualenv
Most likely you’ll want to enter this python virtualenv in your ~/.profile shell script
See here for more information on virtualenv
5) Obtain the Underworld source code
See installation details