add news and fix some spelling mistakes

Author: hexaeder

NEWS.md

@@ -1,8 +1,16 @@
 # NetworkDynamics Release Notes
 
+## v0.10.4 Changelog
+- [#303](https://github.com/JuliaDynamics/NetworkDynamics.jl/pull/303) update for ModelingToolkit.jl v10 compatibility:
+  - rename all `ODESystem` -> `System` (follows MTK v10 API)
+  - MTK extension now uses `mtkcompile` instead of `structural_simplify` internally
+  - Add new `implicit_output` function to handle fully implicit output variables in MTK models
+  - Add documentation for handling fully implicit outputs in MTK integration
+  - Update minimum ModelingToolkit.jl requirement from v9.67 to v10
+
 ## v0.10.3 Changelog
 - [#301](https://github.com/JuliaDynamics/NetworkDynamics.jl/pull/301) improve callback system performance and flexibility:
-  - Add callback batching for better DiscreteComponentCallback performance 
+  - Add callback batching for better DiscreteComponentCallback performance
   - Allow `EIndex(1=>2)` as standalone edge index with relaxed type constraints
   - Optimize CallbackSet construction to prevent performance bottlenecks
   - Add important documentation warning about parameter array copying in callbacks

ext/MTKExt_utils.jl

@@ -152,7 +152,7 @@ function warn_missing_features(sys)
     cev = ModelingToolkit.get_continuous_events(sys)
     dev = ModelingToolkit.get_discrete_events(sys)
     if !isempty(cev) || !isempty(dev)
-        @warn "Model has attached events, which is not supportet."
+        @warn "Model has attached events, which is not supported."
     end
 
     if !isempty(ModelingToolkit.initialization_equations(sys))

ext/NetworkDynamicsMTKExt.jl

@@ -34,7 +34,7 @@ Additional kw arguments:
 - `name`: Set name of the component model. Will be lifted from the System name.
 - `extin=nothing`: Provide external inputs as pairs, i.e. `extin=[:extvar => VIndex(1, :a)]`
    will bound the variable `extvar(t)` in the equations to the state `a` of the first vertex.
-- `ff_to_constraint=true`: Controlls, whether output transformations `g` which depend on inputs should be
+- `ff_to_constraint=true`: Controls, whether output transformations `g` which depend on inputs should be
   transformed into constraints. Defaults to true since ND.jl does not handle vertices with FF yet.
 """
 function VertexModel(sys::System, inputs, outputs; verbose=false, name=getname(sys),
@@ -96,7 +96,7 @@ end
 Create a `EdgeModel` object from a given `System` created with ModelingToolkit for **single sided models**.
 
 Here you only need to provide one list of output symbols: `dstout`.
-To make it clear how to handle the single-sided output definiton, you musst wrap
+To make it clear how to handle the single-sided output definition, you must wrap
 the symbol vector in
 - `AntiSymmetric(dstout)`,
 - `Symmetric(dstout)`, or
@@ -121,7 +121,7 @@ Additional kw arguments:
 - `name`: Set name of the component model. Will be lifted from the System name.
 - `extin=nothing`: Provide external inputs as pairs, i.e. `extin=[:extvar => VIndex(1, :a)]`
    will bound the variable `extvar(t)` in the equations to the state `a` of the first vertex.
-- `ff_to_constraint=false`: Controlls, whether output transformations `g` which depend on inputs should be
+- `ff_to_constraint=false`: Controls, whether output transformations `g` which depend on inputs should be
   transformed into constraints.
 """
 function EdgeModel(sys::System, srcin, dstin, srcout, dstout; verbose=false, name=getname(sys),
@@ -141,7 +141,7 @@ function EdgeModel(sys::System, srcin, dstin, srcout, dstout; verbose=false, nam
     singlesided = isnothing(srcout)
     if singlesided && !(dstout isa AnnotatedSym)
         throw(ArgumentError("If you only provide one output (single sided \
-        model), it musst be wrapped either in `AntiSymmetric`, `Symmetric` or \
+        model), it must be wrapped either in `AntiSymmetric`, `Symmetric` or \
         `Directed`!"))
     end
 
@@ -312,8 +312,8 @@ function generate_io_function(_sys, inputss::Tuple, outputss::Tuple;
             mtkcompile(_sys; inputs=_openinputs, outputs=alloutputs, simplify=false)
         catch e
             if e isa ModelingToolkit.ExtraEquationsSystemException
-                msg = "The system could not be compiled becaus of extra equations! \
-                       Somtimes, this can be related to fully implicit output equations. \
+                msg = "The system could not be compiled because of extra equations! \
+                       Sometimes, this can be related to fully implicit output equations. \
                        Check `@doc implicit_output` for more information."
                 throw(ArgumentError(msg))
             end

src/utils.jl

@@ -248,6 +248,6 @@ equation depends on `x`. This can be necessary to define a model with fully impl
 
 $implicit_output_docstring
 
-For more information see the NetworkDyanmics docs on [Fully Implicit Outputs](@ref).
+For more information see the NetworkDynamics docs on [Fully Implicit Outputs](@ref).
 """
 implicit_output(x) = 0