Improve spelling and grammar in the user guide

docs/src/changelog.md

@@ -63,7 +63,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - For cyclic parameters different cyclic time inputs are supported (only one common cyclic
   time (for example daily or monthly) was allowed).
 - BMI: 1) added grid information (type and location) and whether a variable can be exchanged
-  to metadata Structs, 2) extend model grid functions for Wflow components that store
+  to metadata Structs, 2) extend model grid functions for wflow components that store
   variables on `edges` (local inertial model) with `get_grid_edge_count` and
   `get_grid_edge_nodes`.
 
@@ -107,7 +107,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   seconds since the model start time. This is more in line with standard BMI practices.
 - The `starttime` was defined one model timestep `Δt` ahead of the actual model time (the
   initial conditions timestamp (state time)). As a consequence this was also the case for
-  the current model time. To allow for an easier interpretation of Wflow time handling,
+  the current model time. To allow for an easier interpretation of wflow time handling,
   either through BMI or directly, the `starttime` is now equal to the state time, resulting
   in current model times without an offset.
 - Using more than 8 threads can result in too much overhead with `Threads.@threads`. After
@@ -128,7 +128,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## v0.6.3 - 2023-03-01
 
 ### Fixed
-- Removed error when `_FillValue` is present in the time dimension of the forcing NetCDF
+- Removed error when `_FillValue` is present in the time dimension of the forcing netCDF
   file. The simulation is allowed to continue with the attribute present, given that there
   are no missing values in the time dimension. This is checked by the code, and an error is
   thrown if this is the case.
@@ -137,9 +137,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   counted).
 
 ### Changed
-- `NCDatasets` version. Reading the `time` dimension of multifile NetCDF file became very
+- `NCDatasets` version. Reading the `time` dimension of multifile netCDF file became very
   slow since `NCDatasets` v0.12.4, this issue has been solved in v0.12.11.
-- Store the `time` dimension of the forcing NetCDF file as part of the struct `NCreader`
+- Store the `time` dimension of the forcing netCDF file as part of the struct `NCreader`
   instead of calling `dataset["time"][:]` each time step when loading forcing data.
 
 ### Added
@@ -195,7 +195,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   parameters](@ref).
 - Modify input parameters with an extra dimension at multiple indices with different `scale`
   and `offset` values, through the TOML file. See also [Modify parameters](@ref).
-- Added support for NetCDF compression for gridded model output, through the option
+- Added support for netCDF compression for gridded model output, through the option
   `compressionlevel` in the `[output]` section in the TOML file. The setting defaults to 0
   (no compression), but all levels between 0 and 9 can be used.
 
@@ -246,7 +246,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 - Model type `hbv`: the surface width for overland flow was not corrected with the river
   width.
-- Fixed use of absolute path for `path_forcing` in TOML file, which gave an error in Wflow
+- Fixed use of absolute path for `path_forcing` in TOML file, which gave an error in wflow
   v0.5.1.
 - Fixed a crash when glacier processes are simulated as part of the `hbv` concept (Δt was
   not defined).
@@ -257,10 +257,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fixed how number of iterations `its` for kinematic wave river flow are calculated during
   initialization when using a fixed sub-timestep (specified in the TOML file). For a model
   timestep smaller than the fixed sub-timestep an InexactError was thrown.
-- Fixed providing a cyclic parameter when the NetCDF variable is read during model
-  initialization with `ncread`, this gave an error about the size of the NetCDF `time`
+- Fixed providing a cyclic parameter when the netCDF variable is read during model
+  initialization with `ncread`, this gave an error about the size of the netCDF `time`
   dimension.
-- Fixed CSV and NetCDF scalar output of variables with dimension `layer` (`SVector`).
+- Fixed CSV and netCDF scalar output of variables with dimension `layer` (`SVector`).
 
 ## v0.5.1 - 2021-11-24
 
@@ -354,7 +354,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   larger or smaller than `xp`, maximum(`xp`) or minimum(`xp`) was returned instead of
   maximum(`fp`) or minimum(`fp`).
 - Fixed model timestep of reservoirs (`SimpleReservoir`) and lakes (`NaturalLake`) in
-  relation to precipitation and evapotranspiration fluxes. This was set to the fixed Wflow
+  relation to precipitation and evapotranspiration fluxes. This was set to the fixed wflow
   `basetimestep` of 86400 s, and should be set to the actual model time step from the TOML
   configuration file.
 - Add `flux` from `Drainage` (`GroundwaterFlow`) in the `sbm_gwf_model` to the overland flow
@@ -373,7 +373,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## v0.3.1 - 2021-05-19
 
 ### Fixed
-- Ignore extra dimensions in input NetCDFs if they are size 1
+- Ignore extra dimensions in input netCDFs if they are size 1
 
 ## v0.3.0 - 2021-05-10
 
@@ -406,7 +406,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 - Removed dependency of the `f` model parameter of wflow\_sbm on the parameters
   ``\theta_{s}``, ``\theta_{r}`` and ``M``. This approach is used in Topog\_SBM, but not
-  applicable for wflow\_sbm. The `f` parameter needs to be provided as part of the NetCDF
+  applicable for wflow\_sbm. The `f` parameter needs to be provided as part of the netCDF
   model parameter file.
 - Grid properties as cell length and elevation now stored as part of the
   `model.land.network` component and not as part of the vertical model components, as it is
@@ -416,10 +416,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Removed parameter ``\theta_{e}`` from SBM struct (not used in update). Parameters
   ``\theta_{s}`` and ``\theta_{r}`` included separately (instead of ``\theta_{e}``) in
   `LateralSSF struct`, now directly linked to SBM parameters.
-- Improve error messages (NetCDF and cyclic flow graph).
+- Improve error messages (netCDF and cyclic flow graph).
 
 ### Added
-- Export of NetCDF scalar timeseries (separate NetCDF file from gridded timeseries). This
+- Export of netCDF scalar timeseries (separate netCDF file from gridded timeseries). This
   also allows for importing these timeseries by Delft-FEWS (General Adapter).
 
 ### Fixed

docs/src/intro/use_cases.md

@@ -8,7 +8,7 @@ planning. In collaboration with Rijkswaterstaat, Deltares is setting-up a new li
 for the Rhine and the Meuse basins. The models will be used for forecasting and to estimate the
 impact of climate change on water resources and extreme streamflow. In the model development,
 we seek to improve hydrological predictions by including relevant processes in the model
-schematization. The modularity of the Wflow framework is ideal for this as we can easily
+schematization. The modularity of the wflow framework is ideal for this as we can easily
 evaluate the combination of different vertical and lateral model components. For example, the
 local inertial routing for river and overland flow enables us to consider retention of water in
 the floodplains, which will likely improve extreme streamflow predictions.
@@ -49,7 +49,7 @@ flood inundation forecasting in Australia. Hydrology Water and Resources Symposi
 ## [Simulating plastic transport in Thailand](@id case_mfa)
 
 For the Polution Control Board of the Government of Thailand and The World Bank, we supported
-the material flow analysis of plastics in Thailand using Wflow. Plastic polution is a growing
+the material flow analysis of plastics in Thailand using wflow. Plastic polution is a growing
 problem globally. Plastic waste enters the rivers and is transported to the ocean where it
 remains and threatens the health of the ocean, seas and coasts. The initial movement of plastic
 waste is in many cases triggered by runoff from (heavy) rainfall and with the flow of water

docs/src/model_docs/model_configurations.md

@@ -182,7 +182,7 @@ The kinematic wave function is used to route the water downstream. In a similar
 HBV, all runoff that is generated in a cell in one of the FLEXTopo storages is added to the
 kinematic wave reservoir at the end of a timestep. There is no connection between the
 different vertical FLEXTopo cells within the model. The FLEXTopo model is implemented in a
-fully distributed way in the Wflow Julia framework.
+fully distributed way in the wflow Julia framework.
 
 In wflow\_flextopo, the user is free to determine the number of classes and which model
 components to include or exclude for each class, this is done in the TOML file. Currently,

docs/src/model_docs/params_lateral.md

@@ -381,7 +381,7 @@ internal model parameter `z`, and is listed in the Table below between parenthes
 ### Confined aquifer
 The Table below shows the parameters (fields) of struct `ConfinedAquifer`, including a
 description of these parameters, the unit, and default value if applicable. Struct
-`ConfinedAquifer` is not (yet) part of a Wflow Model.
+`ConfinedAquifer` is not (yet) part of a wflow model.
 
 |  parameter  | description  	      | unit  | default |
 |:--------------- | ------------------| ----- | -------|

docs/src/model_docs/structures.md

@@ -19,7 +19,7 @@ end
 ```
 
 The `lateral` field of the `struct Model` can contain different lateral concepts. For each
-Wflow model these different lateral concepts are mapped through the use of a `NamedTuple`.
+wflow model these different lateral concepts are mapped through the use of a `NamedTuple`.
 The `vertical` field of the `struct Model` always contains one vertical concept, for example
 the SBM or HBV vertical concept.
 
@@ -41,7 +41,7 @@ name. See also the next paragraph [Vertical and lateral models](@ref) for a more
 detailed description.
 
 ## Vertical and lateral models
-The different model concepts used in Wflow are defined as parametric [composite
+The different model concepts used in wflow are defined as parametric [composite
 types](https://docs.julialang.org/en/v1/manual/types/#Composite-Types). For example the
 vertical `SBM` concept is defined as follows: `struct SBM{T,N,M}`. `T`, `N` and `M` between
 curly braces after the `struct` name refer to type parameters, for more information about
@@ -75,7 +75,7 @@ example with a part of the `SBM` struct:
     kvfrac::Vector{SVector{N,T}} | "-"
 ```
 
-The type parameter `T` is used in Wflow as a subtype of `AbstractFloat`, allowing to store
+The type parameter `T` is used in wflow as a subtype of `AbstractFloat`, allowing to store
 fields with a certain floating point precision (e.g. `Float64` or `Float32`) in a flexible
 way. `N` refers to the maximum number of soil layers of the `SBM` soil column, and `M`
 refers to the maximum number of soil layers + 1. See also part of the following instance of

docs/src/user_guide/additional_options.md

@@ -147,10 +147,10 @@ and land (2D)](@ref), both part of wflow\_sbm, can also run on multiple threads.
 threading functionality for the kinematic wave may also be useful for models that make
 (partly) use of this routing approach as the [wflow_hbv](@ref config_hbv) model and
 the wflow\_sbm model [SBM + Groundwater flow](@ref). The multi-threading functionality in
-Wflow is considered experimental, see also the following
+wflow is considered experimental, see also the following
 [issue](https://github.com/Deltares/Wflow.jl/issues/139), where an error was not thrown
-running code multi-threaded. Because of this we advise to start with running a Wflow model
-single-threaded (for example during the testing phase of setting up an new Wflow model).
+running code multi-threaded. Because of this we advise to start with running a wflow model
+single-threaded (for example during the testing phase of setting up an new wflow model).
 
 For information on how to start Julia with multiple threads we refer to [How to start Julia
 with multiple
@@ -190,14 +190,14 @@ in the [Julia programming language](https://julialang.org/), makes use of the fo
 [Julia specification](https://github.com/Deltares/BasicModelInterface.jl), based on BMI 2.0
 version.
 
-For the BMI implementation of Wflow all grids are defined as [unstructured
+For the BMI implementation of wflow all grids are defined as [unstructured
 grids](https://bmi-spec.readthedocs.io/en/latest/model_grids.html#unstructured-grids),
 including the special cases `scalar` and `points`. While the input (forcing and model
 parameters) is structured (uniform rectilinear), internally wflow works with one dimensional
 arrays based on the active grid cells of the 2D model domain.
 
 ### Configuration
-The variables that Wflow can exchange through BMI are based on the different model
+The variables that wflow can exchange through BMI are based on the different model
 components and these components should be listed under the `API` section of the TOML
 configuration file of the model type. Below an example of this `API` section, that lists the
 `vertical` component and different `lateral` components:
@@ -220,7 +220,7 @@ Wflow.BMI.get_input_var_names
 ```
 
 Variables with a third dimension, for example `layer` as part of the vertical `SBM` concept,
-are exposed as two-dimensional grids through the Wflow BMI implementation. For these
+are exposed as two-dimensional grids through the wflow BMI implementation. For these
 variables the index of this third dimension is required, by adding `[k]` to the variable
 name (`k` refers to the index of the third dimension). For example, the variable
 `vertical.vwc[1]` refers to the first soil layer of the vertical `SBM` concept.
@@ -231,7 +231,7 @@ MODFLOW) it is possible to run:
 - wflow\_sbm in parts from the BMI, and
 - to switch off the lateral subsurface flow component of wflow\_sbm.
 
-The lateral subsurface component of wflow\_sbm is not initialized by Wflow when the
+The lateral subsurface component of wflow\_sbm is not initialized by wflow when the
 `[input.lateral.subsurface]` part of the TOML file is not included. Then from the BMI it is
 possible to run first the recharge part of SBM:
 
@@ -262,18 +262,18 @@ world.
 
 This can be done without a model adapter that provides the interface between Delft-FEWS and
 an external model (or module). This is possible because time information in the TOML
-configuration file is optional and Delft-FEWS can import and export NetCDF files. When time
+configuration file is optional and Delft-FEWS can import and export netCDF files. When time
 information is left out from the TOML configuration file, the `starttime`, `endtime` and
-`timestepsecs` (timestep) of the run is extracted from the NetCDF forcing file by Wflow.
+`timestepsecs` (timestep) of the run is extracted from the netCDF forcing file by wflow.
 
-To indicate that a Wflow model runs from Delft-FEWS, the following setting needs to be
+To indicate that a wflow model runs from Delft-FEWS, the following setting needs to be
 specified in the main section of the TOML configuration file:
 
 ```toml
 fews_run = true  # optional, default value is false
 ```
 
-This ensures that Wflow offsets the time handling, to meet the expectations of Delft-FEWS.
+This ensures that wflow offsets the time handling, to meet the expectations of Delft-FEWS.
 
 It also uses a different format for the log file such that each log message takes up only
 one line. That meets the [General Adapter
@@ -290,8 +290,8 @@ expectations, which then can get parsed with these Delft-FEWS log parsing settin
 </logFile>
 ```
 
-## [Run Wflow as a ZMQ Server]
-It is possible to run Wflow as a ZMQ Server, for example for the coupling to the
-[OpenDA](https://openda.org/) software for data-assimilation. The code for the Wflow ZMQ
+## [Run wflow as a ZMQ Server]
+It is possible to run wflow as a ZMQ Server, for example for the coupling to the
+[OpenDA](https://openda.org/) software for data-assimilation. The code for the wflow ZMQ
 Server is not part of the Wflow.jl package, and is located
 [here](https://github.com/Deltares/Wflow.jl/tree/zmq_server/server).

docs/src/user_guide/install.md

@@ -20,7 +20,7 @@ Wflow can be used in two different ways, depending on the required use of the co
   version is available. This consists of a single executable, `wflow_cli`, allowing you to
   run the model via the command line.
 
-Below, we describe how to install both versions of wflow.
+Below we describe how to install both versions of wflow.
 
 ## Installing as Julia package
 
@@ -75,7 +75,7 @@ have to pull in the latest changes yourself using `git pull`.
 
 ### Check installation of wflow
 
-Finally, go back the Julia REPL and try to load wflow:
+Finally, go back to the Julia REPL and try to load wflow:
 
 ```julia-repl
 julia> using Wflow
@@ -85,7 +85,7 @@ The first time this will take longer as any package that is new or changed needs
 pre-compiled first, to allow faster loading on subsequent uses. No error messages should
 appear, indicating that you have now successfully installed wflow.
 
-Before ending this section, we still want to recommend a few tools that can make using and
+Before ending this section, we want to recommend a few tools that can make using and
 developing Julia code easier.
 
 !!! tip
@@ -108,15 +108,15 @@ Binaries of `wflow_cli` can be downloaded from our website
 [download.deltares.nl](https://download.deltares.nl/en/download/wflow/), and are currently
 available for Windows. Download and install the `.msi` file. After installing you can see
 two folders in the installation directory. It is only the `bin/wflow_cli` that is used. The
-artifacts folder contains binary dependencies such as NetCDF.
+artifacts folder contains binary dependencies such as netCDF.
 
 ```
 artifacts\
 bin\wflow_cli
 ```
 
-Check whether the installation was performed successfully, run `wflow_cli` with no
-arguments in the command line will give the following message:
+Check whether the installation was performed successfully by running `wflow_cli` with no
+arguments in the command line. This will give the following message:
 
 ```
 Usage: wflow_cli 'path/to/config.toml'

docs/src/user_guide/intro.md

@@ -2,12 +2,12 @@
 
 The purpose of this user guide is to describe the steps to install the wflow julia software
 and to set up a simple model. The user guide also contains a step-wise process how to
-configure your model using the TOML file (model settings) and the NetCDF gridded datasets.
+configure your model using the TOML file (model settings) and the netCDF gridded datasets.
 
 Sample data and model set up is also included for the Moselle River Basin (a major tributary
 of the Rhine River), which can be used to explore the model software. The model is set up
 for the wflow\_sbm, wflow\_hbv and wflow\_sediment model concepts.
 
-Finally information is provided on setting up your own model, including building a model
+Finally, information is provided on setting up your own model, including building a model
 from scratch or alternatively using Deltares [HydroMT](https://github.com/Deltares/hydromt)
 model building tools which are open source.