:notoc: .. toctree:: :hidden: :titlesonly: quick_start/index.rst user_guide/index.rst api_reference/index.rst contributing/index.rst ************************ SunPeek documentation ************************ **Date**: |today| **Useful links**: `Website `__ | `Source Repository `__ | `Issues & Ideas `__ | `Contact `__ :mod:`SunPeek` is an free and open-source software for the performance assessment of solar-thermal plants, implementing the *Power Check of ISO 24914:2022*. .. grid:: 1 2 2 2 :gutter: 4 :padding: 2 2 0 0 :class-container: sd-text-center custom-grid .. grid-item-card:: Quick Start :img-top: _static/mdi/rocket-launch.svg :class-card: intro-card :shadow: md New to *SunPeek*? Check out the quick guide to get started. They contain an introduction to SunPeek, the installation guide, and some tutorials. +++ .. button-ref:: quick_start :click-parent: :color: secondary :expand: To the quick start .. grid-item-card:: User Guide :img-top: _static/mdi/book-open-variant-outline.svg :class-card: intro-card :shadow: md The user guide provides in-depth information on the key concepts of SunPeek with useful background information and explanation. +++ .. button-ref:: user_guide :click-parent: :color: secondary :expand: To the user guide .. grid-item-card:: API reference :img-top: _static/mdi/code-tags.svg :class-card: intro-card :shadow: md The reference guide contains a detailed description of the SunPeek API. The reference describes how the methods work and which parameters can be used. It assumes that you have an understanding of the key concepts. +++ .. button-ref:: api_reference/index :click-parent: :color: secondary :expand: To the reference guide .. grid-item-card:: Contribution guide :img-top: _static/mdi/account-group.svg :class-card: intro-card :shadow: md Do you want to become part of the team? We are always happy to welcome new people to the project. Click here to get more information how to contribute. +++ .. button-ref:: contributing/index :click-parent: :color: secondary :expand: To the development guide .. the layout of this page was adapted from the `python pandas `__ documentation with many thanks!