Skip to content

Theory guide #70

Open
Open

Description

@prehner

I want to include a theory guide with the documentation of FeOs. The scope should be clearly separated from the user and developer guides that are already part of the documentation. That means, it is supposed to focus on the theory underlying the code and not on implementation details. Basically, it is supposed to outline which equations the code aims to solve and which models are included.

The following topics could at some point be part of the guide:

If you would like to contribute to any of these or other topics, leave a comment below or open a pull request :)

Activity

  1. g-bauer commented on Nov 10, 2022

    @g-bauer
    Contributor

    Sounds great! Where would we include this in the docs? Currently we have PYTHON and RUST as sections in the TOC on the lhs of our documentation (github pages). Would you add a THEORY section with the above structure as entries?

  2. prehner commented on Nov 10, 2022

    @prehner
    ContributorAuthor

    Sounds good, I started the writing the guide using your suggested toc structure in #60

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions