Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Theory guide #70

Open
8 of 20 tasks
prehner opened this issue Nov 10, 2022 · 2 comments
Open
8 of 20 tasks

Theory guide #70

prehner opened this issue Nov 10, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@prehner
Copy link
Contributor

prehner commented Nov 10, 2022

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 :)

@g-bauer
Copy link
Contributor

g-bauer commented Nov 10, 2022

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?

@prehner
Copy link
Contributor Author

prehner commented Nov 10, 2022

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

@prehner prehner added the documentation Improvements or additions to documentation label Nov 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants