Skip to content
Snippets Groups Projects
Commit 09816717 authored by Martin Lange's avatar Martin Lange
Browse files

create the book part, integrate in index and about

parent 7daf6c3e
No related branches found
No related tags found
1 merge request!143FINAM Cookbook & Blog
Pipeline #124055 passed with stages
in 2 minutes and 57 seconds
......@@ -4,9 +4,10 @@ About this book
This book has multiple purposes:
* :doc:`principles/index` -- Explain the basic principles of FINAM to the interested audience
* :doc:`usage/index` -- Teach end users how to set up and run FINAM compositions
* :doc:`development/index` -- Teach developers how to implement FINAM modules, and how to wrap existing models for coupling
* :doc:`principles/index` -- Explain the basic principles of FINAM to the interested audience.
* :doc:`usage/index` -- Teach end users how to set up and run FINAM compositions.
* :doc:`development/index` -- Teach developers how to implement FINAM modules and adapters, and how to wrap existing models for coupling.
* :doc:`cookbook/index` -- Help users and developers with short recipes demonstrating how to solve specific tasks with and for FINAM.
All except the chapters on principles require some Python programming skills.
We do not teach Python in this book, so different levels of programming knowledge
......@@ -28,3 +29,8 @@ The chapters under :doc:`development/index` are dedicated to developers
that want to build modules for FINAM, or wrap existing models or libraries for the use in FINAM compositions.
To write modules following these chapters, intermediate knowledge of Python is required.
Particularly, developers need some basic understanding of object-oriented programming in Python.
The recipes of the :doc:`cookbook/index` are dedicated to users and developers
that are facing questions and tasks that might be common when working with FINAM.
Expect code examples that require Python knowledge according to the usage or development chapter,
depending on the subject.
==============
FINAM cookbook
==============
A loose collection or recipes for solving tasks and problems frequently encountered when working with FINAM.
.. toctree::
:glob:
:titlesonly:
:maxdepth: 2
**
......@@ -19,6 +19,7 @@ This approach allows for coupling of models irrespective of their internal struc
* :doc:`principles/index` -- Explains basic principles of the FINAM framework that are of interest for users as well as developers.
* :doc:`usage/index` -- Guide for users that aim at coupling existing models.
* :doc:`development/index` -- Guide for developers on how to prepare models for FINAM, and how to implement adapters.
* :doc:`cookbook/index` -- Short recipes demonstrating how to solve specific tasks with and for FINAM.
.. toctree::
:hidden:
......@@ -36,3 +37,4 @@ This approach allows for coupling of models irrespective of their internal struc
principles/index
usage/index
development/index
cookbook/index
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment