Welcome to Shamrock’s documentation!

This page aims at documenting both the User and developer documentation of Shamrock.

Main documentation (Link)

The main documentation of the code, it includes installation, and usage of the code.

If something is unclear or not documented please open an issue here.

Runscript examples (Link)

A very nice list of examples of Shamrock scripts, for those who prefer examples. :)

If any example goes amiss please open an issue here.

Python API (Link)

The documentation of the Python API, here all python function, classes, and modules are listed.

If any functionally does not possess a corresponding python binding please open an issue here.

C++ API (Link)

The documentation of the part of the C++ code.

It is more of a technical documentation to reference what every function is rather than an end-user documentation.

If something is unclear or not documented please open an issue here.

Contents:

• Home page
• User Guide
• Dev Doc
• Shamrock’s example gallery
• Benchmarks Examples
• Math Examples
• Physics Examples
• Ramses solver examples
• SPH Examples
• Shamrock CI tests
• Python API

Indices and tables

• Index

• Module Index

• Search Page