Merge pull request #249 from kafu16/nb/docs_typos

few typos in the docs

Author: hexaeder

NetworkDynamicsInspector/src/NetworkDynamicsInspector.jl

@@ -123,7 +123,7 @@ end
     inspect(sol; restart=false, reset=false, display=nothing)
 
 Main entry point for gui. Starts the server and serves the app for
-soution `sol`.
+solution `sol`.
 
 - `restart`: If `true`, the display will be restartet (i.e. new Electron window, new server or new Browser tab)
 - `reset`: If `true`, reset the appstate with the new solution `sol`.

docs/examples/cascading_failure.jl

@@ -2,7 +2,7 @@
 # Cascading Failure
 This script reimplements the minimal example of a dynamic cascading failure
 described in Schäfer et al. (2018) [1].
-In is an example how to use callback functions to change network parameters. In
+This is an example how to use callback functions to change network parameters. In
 this case to disable certain lines.
 This script can be dowloaded as a normal Julia script [here](@__NAME__.jl). #md
 

docs/src/callbacks.md

@@ -8,7 +8,7 @@ Within the affect function, it is safe to modify the integrator, e.g. changing s
 Since `NetworkDynamics.jl` provides nothing more than a RHS for DifferentialEquations.jl, please check
 [their docs on event handling](https://docs.sciml.ai/DiffEqDocs/stable/features/callback_functions/)
 as a general reference.
-This page at introducing the general concepts, for a hands on example of a simulation with callbacks
+This page is introducing the general concepts, for a hands on example of a simulation with callbacks
 refer to the [Cascading Failure](@ref) example.
 
 
@@ -67,7 +67,7 @@ vectoraffect = ComponentAffect([:u], [:p]) do u, p, event_idx, ctx
 end
 ```
 Notably, the `syms` (here `:u`) can *exclusivly* refer to "ordinary" states, since they are now writable.
-However the affect gets passed a `ctx` "context" object, which is a named tuple which holds additional context like the integrator object, the component model, the index of the component model, the current time and so on. Please refere to the [`ComponentAffect`](@ref) docstring for a detailed list.
+However the affect gets passed a `ctx` "context" object, which is a named tuple which holds additional context like the integrator object, the component model, the index of the component model, the current time and so on. Please refer to the [`ComponentAffect`](@ref) docstring for a detailed list.
 
 Lastly we need to define the actuall callback object using [`ContinousComponentCallback`](@ref)/[`VectorContinousComponentCallback`](@ref):
 ```julia
@@ -116,7 +116,7 @@ condition = let getvalue = SII.getsym(nw, VIndex(1:5, :some_state))
     end
 end
 ```
-Please not a few important things here:
+Please note a few important things here:
  - Symbolic indexing can be costly, and the condition function gets called very
    often. By using [`SII.getsym`](@extref `SymbolicIndexingInterface.getsym`) we did
    some of the work *before* the callback by creating the accessor function.

docs/src/mathematical_model.md

@@ -1,5 +1,5 @@
 # Mathematical Model
-The basic mathematical model of `NetworkDynamics.jl` splits up the system it two parts: vertex and edge components.
+The basic mathematical model of `NetworkDynamics.jl` splits up the system into two parts: vertex and edge components.
 
 The main goal of `NetworkDynamics.jl` is, to express the overall network dynamics as a Differential-Algebraic-Equation (DAE)
 ```math

docs/src/mtk_integration.md

@@ -1,6 +1,6 @@
 # ModelingToolkit Integration
 
-NetworkDynamics.jl is compatible with [`ModelingTookit.jl`](https://github.com/SciML/ModelingToolkit.jl) (MTK).
+NetworkDynamics.jl is compatible with [`ModelingToolkit.jl`](https://github.com/SciML/ModelingToolkit.jl) (MTK).
 The general idea is to use MTK to define *component models* (i.e. edge and vertex dynamics)
 which are then connected on network scale using NetworkDynamics.
 
@@ -12,8 +12,8 @@ EdgeModel(::ODESystem, srcin, dstin, [srscout], dstout)
 whose docstrings can be found in the [Component Models with MTK](@ref) section in the API.
 
 These constructors will:
-- transforming the states marked as input to parameters and `structural_simplify`ing the system,
-- generating the `f` and `g` functions,
+- transform the states marked as input to parameters and `structural_simplify`ing the system,
+- generate the `f` and `g` functions,
 - generate code for observables,
 - port all supported [Metadata](@ref) from MTK symbols to component symbols and
 - output a `Vertex-`/`EdgeModel` function compatible with NetworkDynamics.jl.

docs/src/network_construction.md

@@ -1,7 +1,7 @@
 # Network Construction
 
 ## Building a Network
-The main type of `NetworkDyanmics.jl` is a [`Network`](@ref).
+The main type of `NetworkDynamics.jl` is a [`Network`](@ref).
 A network bundles various component models (edge and vertex models) together with a graph to form a callable object which represents the RHS of the overall dynamical system, see [Mathematical Model](@ref).
 
 A `Network` is build by passing a graph `g`, vertex models `vertexm` and edge models `edgem`.
@@ -20,7 +20,7 @@ Two important keywords for the [`Network`](@ref) constructor are:
     Tells the backend how to aggregate and which aggregation function to use.
     Aggregation is the process of creating a single vertex input by reducing over
     the outputs of adjecent edges of said vertex. The `aggregator` contains both the
-    function and the algorith. E.g. `SequentialAggregator(+)` is a sequential
+    function and the algorithm. E.g. `SequentialAggregator(+)` is a sequential
     aggregation by summation. A list of availabe Aggregators can be found under
     [`Aggregators`](@ref) in the API.
 

docs/src/symbolic_indexing.md

@@ -69,7 +69,7 @@ To access the state or parameters of a network, you can use the [`NWState`](@ref
 p = NWParameter(nw)
 ```
 creates a `NWParameter` object for the network `nw`.
-It essentially creates a new flat parameter array and fills it with the default parameter values define in the component.
+It essentially creates a new flat parameter array and fills it with the default parameter values defined in the component.
 The parameters in the `NWParameter` object can be accessed using symbolic indices.
 ```@example si
 p[EPIndex(5, :K)] = 2.0 # change the parameter K of the 5th edge