Welcome to Shamrock python bindings’s documentation!#

This page aims at documenting the python layer 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 Exemples (Link)

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

If any exemples 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.

Indices and tables#