Merge branch 'master' into bgc/split_params_bug

Author: YingboMa

.github/workflows/Documentation.yml

@@ -7,6 +7,12 @@ on:
     tags: '*'
   pull_request:
 
+concurrency:
+  # Skip intermediate builds: always, but for the master branch.
+  # Cancel intermediate builds: always, but for the master branch.
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.ref != 'refs/heads/master' && github.refs != 'refs/tags/*'}}
+
 jobs:
   build:
     runs-on: ubuntu-latest

.github/workflows/Downstream.yml

@@ -4,6 +4,14 @@ on:
     branches: [master]
     tags: [v*]
   pull_request:
+    paths-ignore:
+        - 'docs/**'
+
+concurrency:
+  # Skip intermediate builds: always, but for the master branch and tags.
+  # Cancel intermediate builds: always, but for the master branch and tags.
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.ref != 'refs/heads/master' && github.refs != 'refs/tags/*' }}
 
 jobs:
   test:

.github/workflows/FormatCheck.yml

@@ -8,6 +8,12 @@ on:
     tags: '*'
   pull_request:
 
+concurrency:
+  # Skip intermediate builds: always, but for the master branch and tags.
+  # Cancel intermediate builds: always, but for the master branch and tags.
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.ref != 'refs/heads/master' && github.refs != 'refs/tags/*'}}
+
 jobs:
   build:
     runs-on: ${{ matrix.os }}

.github/workflows/Invalidations.yml

@@ -2,6 +2,8 @@ name: Invalidations
 
 on:
   pull_request:
+    paths-ignore:
+        - 'docs/**'
 
 concurrency:
   # Skip intermediate builds: always.
@@ -30,7 +32,7 @@ jobs:
     - uses: julia-actions/julia-buildpkg@v1
     - uses: julia-actions/julia-invalidations@v1
       id: invs_default
-    
+
     - name: Report invalidation counts
       run: |
         echo "Invalidations on default branch: ${{ steps.invs_default.outputs.total }} (${{ steps.invs_default.outputs.deps }} via deps)" >> $GITHUB_STEP_SUMMARY

.github/workflows/ci.yml

@@ -10,6 +10,13 @@ on:
       - master
     paths-ignore:
       - 'docs/**'
+
+concurrency:
+  # Skip intermediate builds: always, but for the master branch.
+  # Cancel intermediate builds: always, but for the master branch.
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.ref != 'refs/heads/master' }}
+
 jobs:
   test:
     runs-on: ubuntu-latest

Project.toml

@@ -1,7 +1,7 @@
 name = "ModelingToolkit"
 uuid = "961ee093-0014-501f-94e3-6117800e7a78"
 authors = ["Yingbo Ma <[email protected]>", "Chris Rackauckas <[email protected]> and contributors"]
-version = "8.71.0"
+version = "8.71.1"
 
 [deps]
 AbstractTrees = "1520ce14-60c1-5f80-bbc7-55ef81b5835c"

docs/Project.toml

@@ -25,7 +25,7 @@ Distributions = "0.25"
 Documenter = "1"
 ModelingToolkit = "8.33"
 ModelingToolkitDesigner = "1"
-NonlinearSolve = "0.3, 1"
+NonlinearSolve = "0.3, 1, 2"
 Optim = "1.7"
 Optimization = "3.9"
 OptimizationOptimJL = "0.1"

docs/pages.jl

@@ -21,6 +21,7 @@ pages = [
         "basics/Composition.md",
         "basics/Events.md",
         "basics/Linearization.md",
+        "basics/MTKModel_Connector.md",
         "basics/Validation.md",
         "basics/DependencyGraphs.md",
         "basics/FAQ.md"],

docs/src/basics/MTKModel_Connector.md

@@ -1,8 +1,8 @@
-## Defining components with `@mtkmodel`
+# Defining components with `@mtkmodel`
 
 `@mtkmodel` is a convenience macro to define ModelingToolkit components. It returns `ModelingToolkit.Model`, which includes a constructor that returns an ODESystem, a `structure` dictionary with metadata and flag `isconnector` which is set to `false`.
 
-### What can an MTK-Model definition have?
+## What can an MTK-Model definition have?
 
 `@mtkmodel` definition contains begin blocks of
 
@@ -52,7 +52,7 @@ end
 end
 ```
 
-#### `@parameters` and `@variables` begin block
+### `@parameters` and `@variables` begin block
 
   - Parameters and variables are declared with respective begin blocks.
   - Variables must be functions of an independent variable.
@@ -67,12 +67,12 @@ julia > ModelingToolkit.getdefault(model_c.v)
 2.0
 ```
 
-#### `@structural_parameters` begin block
+### `@structural_parameters` begin block
 
   - This block is for non symbolic input arguements. These are for inputs that usually are not meant to be part of components; but influence how they are defined. One can list inputs like boolean flags, functions etc... here.
   - Whenever default values are specified, unlike parameters/variables, they are reflected in the keyword argument list.
 
-#### `@extend` block
+### `@extend` block
 
 To extend a partial system,
 
@@ -88,7 +88,7 @@ julia> @named model_c = ModelC(; p1 = 2.0)
 
 However, as `p2` isn't listed in the model definition, its default can't be modified by users.
 
-#### `@components` begin block
+### `@components` begin block
 
   - Declare the subcomponents within `@components` begin block.
   - The arguments in these subcomponents are promoted as keyword arguments as `subcomponent_name__argname` with `nothing` as default value.
@@ -102,7 +102,7 @@ julia> @named model_c1 = ModelC(; model_a.k1 = 1);
 
 And as `k2` isn't listed in the sub-component definition of `ModelC`, its default value can't be modified by users.
 
-#### `@equations` begin block
+### `@equations` begin block
 
   - List all the equations here
 
@@ -130,11 +130,8 @@ end
 `@connector`s accepts begin blocks of `@components`, `@equations`, `@extend`, `@parameters`, `@structural_parameters`, `@variables`. These keywords mean the same as described above for `@mtkmodel`.
 
 !!! note
-    
     For more examples of usage, checkout [ModelingToolkitStandardLibrary.jl](https://github.com/SciML/ModelingToolkitStandardLibrary.jl/)
 
-* * *
-
 ### What's a `structure` dictionary?
 
 For components defined with `@mtkmodel` or `@connector`, a dictionary with metadata is created. It lists `:components` (sub-component list), `:extend` (the extended states and base system), `:parameters`, `:variables`, ``:kwargs`` (list of keyword arguments), `:independent_variable`, `:equations`.

src/ModelingToolkit.jl

@@ -67,6 +67,7 @@ using PrecompileTools, Reexport
         substituter, scalarize, getparent
 
     import DiffEqBase: @add_kwonly
+    import OrdinaryDiffEq
 
     import Graphs: SimpleDiGraph, add_edge!, incidence_matrix