Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
finam
Manage
Activity
Members
Labels
Plan
Issues
31
Issue boards
Milestones
Code
Merge requests
3
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Monitor
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
FINAM
finam
Commits
09816717
Commit
09816717
authored
2 years ago
by
Martin Lange
Browse files
Options
Downloads
Patches
Plain Diff
create the book part, integrate in index and about
parent
7daf6c3e
No related branches found
Branches containing commit
No related tags found
Tags containing commit
1 merge request
!143
FINAM Cookbook & Blog
Pipeline
#124055
passed with stages
in 2 minutes and 57 seconds
Changes
3
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
docs/source/finam-book/about.rst
+9
-3
9 additions, 3 deletions
docs/source/finam-book/about.rst
docs/source/finam-book/cookbook/index.rst
+12
-0
12 additions, 0 deletions
docs/source/finam-book/cookbook/index.rst
docs/source/finam-book/index.rst
+2
-0
2 additions, 0 deletions
docs/source/finam-book/index.rst
with
23 additions
and
3 deletions
docs/source/finam-book/about.rst
+
9
−
3
View file @
09816717
...
...
@@ -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.
This diff is collapsed.
Click to expand it.
docs/source/finam-book/cookbook/index.rst
0 → 100644
+
12
−
0
View file @
09816717
==============
FINAM cookbook
==============
A loose collection or recipes for solving tasks and problems frequently encountered when working with FINAM.
.. toctree::
:glob:
:titlesonly:
:maxdepth: 2
**
This diff is collapsed.
Click to expand it.
docs/source/finam-book/index.rst
+
2
−
0
View file @
09816717
...
...
@@ -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
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment