Getting Started¶
Download and Install¶
A local build and installation provides greater control over build options and optimization. HONEE is open-source and can be downloaded from the HONEE repository on GitLab.
$ git clone https://gitlab.com/phypid/honee
Prerequisites¶
HONEE is based upon libCEED and PETSc.
libCEED¶
HONEE requires libCEED’s main
development branch, which can be cloned from Github.
$ git clone https://github.com/CEED/libCEED
$ make -C -j8 libCEED
The above will be enough for most simple CPU installations; see the libCEED documentation for details on using GPUs, tuning, and more complicated environments.
PETSc¶
HONEE requires PETSc’s main
development branch, which can be cloned from GitLab.
$ git clone https://gitlab.com/petsc/petsc
Follow the PETSc documentation to configure and build PETSc.
It is recommended that you install with CGNS library support using --download-hdf5 --download-cgns
.
Building¶
The environment variables CEED_DIR
, PETSC_DIR
, and PETSC_ARCH
must be set to build HONEE.
Assuming you have cloned the HONEE repository as above, build using:
$ export CEED_DIR=[path to libCEED] PETSC_DIR=[path to PETSc] PETSC_ARCH=[PETSc arch]
$ make -j8
To run a sample problem, run:
$ build/navierstokes -options_file examples/gaussianwave.yaml
To test the installation, use
$ make test -j8