Welcome to Ginkgo’s documentation!

This documentation is written with sphinx and markdown. To use markdown files in sphinx we use the myst parser.

Attention

what wording to use?

  • backend vs module

  • interfaces like transpose, conversion, etc under linop or under matrix?

user guide structure: user-guide/ contains top level .md files that are the entry point to a certain concept. This top level file should contain the most important bits of information. Details should be left to files under concept/file.md. For example vectors.md mentions the creation function with arrays, but how to use this to get user data into vectors is done in vectors/user-data.md

reading order:

  1. getting-started: very high-level overview, introduces backends, example

  2. build-install: getting ginkgo running

  3. executors: introduce executor concept + specific executors

  4. vectors: creating and handling of (dense) vectors

  5. matrices: general creating and handling (apply) of matrices, link to matrix formats

  6. linear-operators: generalize matrices, polymorphic object stuff

  7. linear-solvers: iterative and direct solvers, preconditioners as links

  8. distributed: larger category, recaps vectors, linops, solvers for distributed settings

  9. object-configuration: description of config format

  10. logging: adding loggers to objects

  11. arrays: description of ginkgo arrays, is already referenced earlier

  12. extensions

  13. mixed-precision