-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[doc] see what this looks like for build
- Loading branch information
Showing
2 changed files
with
17 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,18 @@ | ||
Compiliation | ||
============ | ||
|
||
Third-Party Libraries | ||
--------------------- | ||
|
||
`CALIBR8` has required dependencies on | ||
|
||
* `zlib-ng <https://github.com/zlib-ng/zlib-ng>`_ - for file formats | ||
* `hdf5 <https://www.hdfgroup.org/solutions/hdf5/>`_ - for file formats | ||
* `netcdf <https://www.unidata.ucar.edu/software/netcdf/>`_ - for file formats | ||
* `parmetis <https://github.com/KarypisLab/ParMETIS>`_ - for parallel partitioning | ||
* `Trilinos <https://github.com/trilinos/Trilinos>`_ - for automatic differentiation, linear solvers | ||
* `scorec/core <https://github.com/SCOREC/core/tree/master>`_ - for mesh adaptation, finite elements | ||
* `Eigen <https://gitlab.com/libeigen/eigen>`_ - for small dense linear algebra | ||
|
||
zlib-ng | ||
------- | ||
|
||
We source `zlib-ng` from the following repo and SHA | ||
|
||
.. code-block:: bash | ||
git clone git@github.com:zlib-ng/zlib-ng.git | ||
e9d0177feafa3adad6ca90cadd44b50389ac4094 | ||
.. code-block:: bash | ||
-DBUILD_SHARED_LIBS=${CALIBR8_BUILD_SHARED_LIBS} | ||
-DZLIB_COMPAT=ON | ||
CALIBR8 uses the `CApp<https://github.com/sandialabs/capp>`_ | ||
build tool, which coordinates the entire build process. In particular, | ||
it acquires and builds all approriate third-party libraries. | ||
|
||
Requirements | ||
------------ | ||
|
||
1. Install or (on HPC systems) load modules for required tools | ||
1. CMake (>3.21) | ||
1. Git (>2.39) | ||
1. C and C++ compilers (with C++17 support). If needed, use the | ||
`CC` and `CXX` environment variables you want to distinguish them | ||
from others in the `PATH`. | ||
1. MPI with C and C++ compiler support | ||
1. Python 3 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters