Skip to content

Latest commit

 

History

History
50 lines (37 loc) · 1.38 KB

COMPILE.md

File metadata and controls

50 lines (37 loc) · 1.38 KB
Raw

Underworld 2 Compilation

Note that for most personal computer usage, we recommend using Underworld through a Docker container environment. See README.md for details.

For HPC usage, you will generally need to compile Underworld, though we support Shifter where available (check with the HPC admins). Basic compilation information is below, though please submit a github issue if you have have difficulties.

Dependencies

  • MPI
  • PETSc
  • numpy
  • swig
  • h5py-mpi

Getting the code

git clone https://github.com/underworldcode/underworld2.git

Compilation

We periodically post build recipes for particular platforms on the underworld blog but the build strategy generally looks like this

    $ cd libUnderworld
    $ ./configure.py
    $ ./compile.py

Check available configuration options using ./configure.py --help.
Library testing options may be found by running ./scons.py --help.

Self compiled Underworld2 usage

You will first need to make the project directory available to import within python:

    $ export PYTHONPATH=$PYTHONPATH:/top/directory/of/project

(note that if you are not using the bash shell, the required command will be different.)