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

Add usage examples and workflow to README.md #7

Closed
peanutfun opened this issue Feb 11, 2022 · 3 comments
Closed

Add usage examples and workflow to README.md #7

peanutfun opened this issue Feb 11, 2022 · 3 comments

Comments

@peanutfun
Copy link
Contributor

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

@cgrudz
Copy link
Owner

cgrudz commented Sep 7, 2022

I think the following documentation section satisfies this
https://cgrudz.github.io/DataAssimilationBenchmarks.jl/dev/submodules/experiments/ParallelExperimentDriver/#Example-usage
though this package still assumes that one will dev the package to design their own experiments and create typical hyper-paramter configurations to load with them. I'm leaving this issue open for now while the review continues and while we re-submit our package for further discussion if the system makes sense.

@cgrudz
Copy link
Owner

cgrudz commented Sep 9, 2022

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.

@cgrudz cgrudz closed this as completed Sep 9, 2022
@peanutfun
Copy link
Contributor Author

Very good, thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants