Skip to content

ginkgo-project/integrations

Repository files navigation

Ginkgo Integrations

Standalone examples demonstrating how Ginkgo integrates with scientific computing libraries.

Library Examples Integration Type
deal.II Poisson, Adaptive Refinement CSR matrix handoff, solver re-generation
MFEM Poisson, High-Order Diffusion CSR wrapping, built-in MFEM-Ginkgo interface
NekRS Poisson, Turbulent Channel Custom LinOp wrappers, GPU pointer sharing
SUNDIALS Poisson (KINSOL), Stiff ODE (CVODE) Native SUNLinearSolver/SUNMatrix interface

Structure

Each example is fully standalone with its own CMakeLists.txt and CMakePresets.json. No global build system, no interdependencies.

<library>/
  <example>/
    CMakeLists.txt        # Minimal, finds Ginkgo + library
    CMakePresets.json      # Named configurations (default, cuda, ...)
    <source>.cpp           # Self-contained example
    doc.md                 # Documentation with embedded source snippets

Building an Example

cd deal.ii/poisson
cmake -S . -B build --preset default
cmake --build build
./build/poisson

Pass library paths manually if not in system paths:

cmake -S . -B build --preset default \
  -DGinkgo_DIR=/path/to/ginkgo/lib/cmake/Ginkgo \
  -Ddeal.II_DIR=/path/to/dealii

Or create a CMakeUserPresets.json with your local paths.

Documentation

Browse the full documentation at: https://ginkgo-project.github.io/integrations/

To build locally:

pip install -r docs/requirements.txt
sphinx-build -b html -c docs . docs/_build/html

License

BSD 3-Clause. See LICENSE.

About

Showcasing integrations of Ginkgo with various applications.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors