feos-org
Theory guide
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:
-
[ ] EOS
- [x] #99
- [ ] Entropy scaling
- [x] #101
- [ ] Tp-flash
- [ ] bubble and dew points
-
[ ] DFT
- [x] Euler-Lagrange equation
- [x] Functional derivatives
- [ ] #121
- [x] #74
- [ ] grand potential
- [ ] 3D DFT (in particular the calculation of external potentials)
- [ ] planar interfaces
- [x] #116
-
[ ] models
- [x] #148
- [x] #149
- [ ] #72
- [ ] UV?
If you would like to contribute to any of these or other topics, leave a comment below or open a pull request :)
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?
Sounds good, I started the writing the guide using your suggested toc structure in #60