Skip to content

Commit

Permalink
[doc] begin compilation
Browse files Browse the repository at this point in the history
  • Loading branch information
bgranzow committed Apr 23, 2024
1 parent 91898e9 commit b1cb662
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
30 changes: 30 additions & 0 deletions doc/compilation/compilation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
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
1 change: 1 addition & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ Welcome to the Calibr8 documentation.

theory/theory
usage/usage
compilation/compilation

0 comments on commit b1cb662

Please sign in to comment.