Skip to content

Commit

Permalink
document METIS and PAPI
Browse files Browse the repository at this point in the history
  • Loading branch information
upsj committed Apr 8, 2024
1 parent 55017b2 commit b5befd5
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,11 @@ packages can be turned off by disabling the relevant options.
+ GINKGO_BUILD_DOC=ON:
[doxygen](https://www.doxygen.nl/) is required to build the documentation and
additionally [graphviz](https://graphviz.org/) is required to build the class hierarchy graphs.
+ [METIS](http://glaros.dtc.umn.edu/gkhome/metis/metis/overview) is required
when using the `NestedDissection` reordering functionality.
If METIS is not found, the functionality is disabled.
+ [PAPI](https://icl.utk.edu/papi/) is required when using the `Papi` logger.
If PAPI is not found, the functionality is disabled.

Ginkgo attempts to use pre-installed versions of these package if they match
version requirements using `find_package`. Otherwise, the configuration step
Expand Down

0 comments on commit b5befd5

Please sign in to comment.