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

Updated documentation #184

Merged
merged 26 commits into from
Feb 16, 2022
Merged

Updated documentation #184

merged 26 commits into from
Feb 16, 2022

Conversation

JoostBuitink
Copy link
Contributor

@JoostBuitink JoostBuitink commented Dec 23, 2021

Update the structure, and added a more detailed user guide

Edit: preview docs: https://deltares.github.io/Wflow.jl/previews/PR184/

docs/make.jl Outdated Show resolved Hide resolved
@verseve verseve linked an issue Jan 20, 2022 that may be closed by this pull request
@JoostBuitink JoostBuitink marked this pull request as ready for review February 10, 2022 08:34
JoostBuitink and others added 6 commits February 10, 2022 09:46
- in Publications section include section about Citing wflow, leave out the draft paper on wflow_sbm
- wrap lines and some small changes
- describe these concepts more apart, also for the user guide (e.g. model configurations)
- some more line wrapping
Copy link
Member

@verseve verseve left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good @JoostBuitink ! See my review comments and some additional commits.

docs/src/user_guide/step1_requirements.md Show resolved Hide resolved
docs/src/user_guide/step3_input_data.md Outdated Show resolved Hide resolved
docs/src/user_guide/step3_input_data.md Show resolved Hide resolved
docs/src/user_guide/sample_data.md Outdated Show resolved Hide resolved
docs/make.jl Show resolved Hide resolved
docs/src/model_docs/shared_concepts.md Outdated Show resolved Hide resolved
Copy link
Contributor

@hboisgon hboisgon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Super nice new organisation of the docs @JoostBuitink ! And very nice new pictures for the SBM concepts :)
Here just a few comments mainly on install and usage.

docs/src/intro/publications.md Show resolved Hide resolved
docs/src/model_docs/vertical/sediment.md Outdated Show resolved Hide resolved
docs/src/user_guide/additional_options.md Show resolved Hide resolved
docs/src/user_guide/additional_options.md Show resolved Hide resolved
docs/src/user_guide/install.md Show resolved Hide resolved
docs/src/user_guide/step4_running.md Show resolved Hide resolved
use NCDatasets instead of ncinfo for example NetCDF output of forcing.
@JoostBuitink JoostBuitink merged commit 4362220 into master Feb 16, 2022
@JoostBuitink JoostBuitink deleted the new_docs branch February 16, 2022 16:42
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

Successfully merging this pull request may close these issues.

Simplified Bagnold parameters
4 participants