-
Notifications
You must be signed in to change notification settings - Fork 5
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
Add usage examples and workflow to README.md #7
Comments
I think the following documentation section satisfies this |
I decided to add an additional section that sketches the overall workflow, where the documentation is organized a bit to emulate this workflow precisely: https://cgrudz.github.io/DataAssimilationBenchmarks.jl/dev/submodules/experiments/Workflow/ This section in the documentation now discusses how one will go from an installation to the point of running a twin experiment following the submodules in the docs. I think this is now a better solution, though I will certainly take further suggestions on how to clarify the use example of the software. |
Very good, thank you! |
The
README.md
documents the API of the module. As the argument lists are quite extensive, I think it would be helpful to add "typical" usage examples for some of the methods and solvers. In particular, this would help to demonstrate some kind of workflow. Starting out with generating a time series, an example could show how to run different data assimilation methods included in this package, and then how to evaluate the output and compare the methods against each other.Currently, one has to look up a typical argument list in the tests, which is cumbersome.
openjournals/joss-reviews#4129
The text was updated successfully, but these errors were encountered: