search

OpenTerrace / openterrace-python

OpenTerrace: A fast, flexible and extendable Python framework for packed bed thermal energy storage simulations
https://openterrace.github.io/openterrace-python/
GNU General Public License v3.0
19 stars 2 forks source link

Statement of need in doumentation #191

Closed AdamRJensen closed 2 months ago

AdamRJensen commented 2 months ago

The JOSS review asks for:

A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?

This is well done in the paper, but I do not see it in the documentation.

Please correct me if I have missed it. Otherwise, I suggest adding a sentence or two to the landing page stating the need (copy from the paper)

jakobhaervig commented 2 months ago

Thanks for the suggestion. Now added in https://github.com/OpenTerrace/openterrace-python/commit/6b871b6287101fcd54687326de04cfdb460df890