Merge branch 'main' into bgc/sign_convention

Author: bradcarman

.github/dependabot.yml

@@ -7,4 +7,4 @@ updates:
       interval: "weekly"
     ignore:
       - dependency-name: "crate-ci/typos"
-        update-types: ["version-update:semver-patch"]
+        update-types: ["version-update:semver-patch", "version-update:semver-minor"]

.github/workflows/CI.yml

@@ -21,10 +21,10 @@ jobs:
           - '1'
     steps:
       - uses: actions/checkout@v4
-      - uses: julia-actions/setup-julia@v1
+      - uses: julia-actions/setup-julia@v2
         with:
           version: ${{ matrix.version }}
-      - uses: actions/cache@v3
+      - uses: actions/cache@v4
         env:
           cache-name: cache-artifacts
         with:
@@ -37,6 +37,8 @@ jobs:
       - uses: julia-actions/julia-buildpkg@v1
       - uses: julia-actions/julia-runtest@v1
       - uses: julia-actions/julia-processcoverage@v1
-      - uses: codecov/codecov-action@v3
+      - uses: codecov/codecov-action@v4
         with:
           file: lcov.info
+          token: ${{ secrets.CODECOV_TOKEN }}
+          fail_ci_if_error: true

.github/workflows/Documentation.yml

@@ -23,6 +23,6 @@ jobs:
           DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key
         run: julia --project=docs/ --code-coverage=user docs/make.jl
       - uses: julia-actions/julia-processcoverage@v1
-      - uses: codecov/codecov-action@v3
+      - uses: codecov/codecov-action@v4
         with:
           file: lcov.info

.github/workflows/Downgrade.yml

@@ -18,12 +18,12 @@ jobs:
         version: ['1']
     steps:
       - uses: actions/checkout@v4
-      - uses: julia-actions/setup-julia@v1
+      - uses: julia-actions/setup-julia@v2
         with:
           version: ${{ matrix.version }}
-      - uses: cjdoris/julia-downgrade-compat-action@v1
+      - uses: julia-actions/julia-downgrade-compat@v1
 #        if: ${{ matrix.version == '1.6' }}
         with:
           skip: Pkg,TOML
       - uses: julia-actions/julia-buildpkg@v1
-      - uses: julia-actions/julia-runtest@v1
+      - uses: julia-actions/julia-runtest@v1

.github/workflows/Downstream.yml

@@ -20,7 +20,7 @@ jobs:
           - {user: SciML, repo: ModelingToolkit.jl}
     steps:
       - uses: actions/checkout@v4
-      - uses: julia-actions/setup-julia@v1
+      - uses: julia-actions/setup-julia@v2
         with:
           version: ${{ matrix.julia-version }}
           arch: x64
@@ -48,6 +48,8 @@ jobs:
             exit(0)  # Exit immediately, as a success
           end
       - uses: julia-actions/julia-processcoverage@v1
-      - uses: codecov/codecov-action@v3
+      - uses: codecov/codecov-action@v4
         with:
           file: lcov.info
+          token: ${{ secrets.CODECOV_TOKEN }}
+          fail_ci_if_error: true

.github/workflows/Invalidations.yml

@@ -16,7 +16,7 @@ jobs:
     if: github.base_ref == github.event.repository.default_branch
     runs-on: ubuntu-latest
     steps:
-    - uses: julia-actions/setup-julia@v1
+    - uses: julia-actions/setup-julia@v2
       with:
         version: '1'
     - uses: actions/checkout@v4

.github/workflows/SpellCheck.yml

@@ -10,4 +10,4 @@ jobs:
       - name: Checkout Actions Repository
         uses: actions/checkout@v4
       - name: Check spelling
-        uses: crate-ci/typos@v1.17.0 
+        uses: crate-ci/typos@v1.18.0 

.typos.toml

@@ -1,4 +1,5 @@
 [default.extend-words]
 Nd = "Nd"
 nin = "nin"
-coul = "coul"
+coul = "coul"
+isconnection = "isconnection"

Project.toml

@@ -1,7 +1,7 @@
 name = "ModelingToolkitStandardLibrary"
 uuid = "16a59e39-deab-5bd0-87e4-056b12336739"
 authors = ["Chris Rackauckas and Julia Computing"]
-version = "2.3.4"
+version = "2.7.1"
 
 [deps]
 ChainRulesCore = "d360d2e6-b24c-11e9-a2a3-2a2ae2dbcce4"
@@ -13,16 +13,16 @@ Symbolics = "0c5d862f-8b57-4792-8d23-62f2024744c7"
 
 [compat]
 Aqua = "0.8"
-ChainRulesCore = "1"
-ControlSystemsBase = "1"
-DataInterpolations = "4"
-DiffEqBase = "6.103"
+ChainRulesCore = "1.18"
+ControlSystemsBase = "1.4"
+DataInterpolations = "4.6"
+DiffEqBase = "6.147"
 IfElse = "0.1"
 LinearAlgebra = "1.10"
-ModelingToolkit = "8.69"
-OrdinaryDiffEq = "6.33"
+ModelingToolkit = "9.2"
+OrdinaryDiffEq = "6.72"
 SafeTestsets = "0.1"
-Symbolics = "5.2"
+Symbolics = "5.20"
 Test = "1"
 julia = "1.10"
 

README.md

@@ -60,9 +60,9 @@ V = 1.0
 @named ground = Ground()
 
 rc_eqs = [connect(constant.output, source.V)
-    connect(source.p, resistor.p)
-    connect(resistor.n, capacitor.p)
-    connect(capacitor.n, source.n, ground.g)]
+          connect(source.p, resistor.p)
+          connect(resistor.n, capacitor.p)
+          connect(capacitor.n, source.n, ground.g)]
 
 @named rc_model = ODESystem(rc_eqs, t,
     systems = [resistor, capacitor, constant, source, ground])

docs/Project.toml

@@ -13,6 +13,6 @@ ControlSystemsBase = "1.1"
 DifferentialEquations = "7.6"
 Documenter = "1"
 IfElse = "0.1"
-ModelingToolkit = "8.67"
+ModelingToolkit = "9"
 OrdinaryDiffEq = "6.31"
 Plots = "1.36"

docs/pages.jl

@@ -5,7 +5,7 @@ pages = [
         "Custom Components" => "tutorials/custom_component.md",
         "Thermal Conduction Model" => "tutorials/thermal_model.md",
         "DC Motor with Speed Controller" => "tutorials/dc_motor_pi.md",
-        "SampledData Component" => "tutorials/input_component.md",
+        "SampledData Component" => "tutorials/input_component.md"
     ],
     "About Acausal Connections" => [
         "Theory" => "connectors/connections.md",
@@ -18,6 +18,6 @@ pages = [
         "Mechanical Components" => "API/mechanical.md",
         "Thermal Components" => "API/thermal.md",
         "Hydraulic Components" => "API/hydraulic.md",
-        "Linear Analysis" => "API/linear_analysis.md",
-    ],
+        "Linear Analysis" => "API/linear_analysis.md"
+    ]
 ]

docs/src/API/linear_analysis.md

@@ -60,7 +60,7 @@ using ModelingToolkitStandardLibrary.Blocks, ModelingToolkit
 @named C = Gain(-1)             # A P controller
 t = ModelingToolkit.get_iv(P)
 eqs = [connect(P.output, :plant_output, C.input)  # Connect with an automatically created analysis point called :plant_output
-    connect(C.output, :plant_input, P.input)]
+       connect(C.output, :plant_input, P.input)]
 sys = ODESystem(eqs, t, systems = [P, C], name = :feedback_system)
 
 matrices_S = get_sensitivity(sys, :plant_input)[1] # Compute the matrices of a state-space representation of the (input)sensitivity function.

docs/src/API/mechanical.md

@@ -55,3 +55,41 @@ SpeedSensor
 TorqueSensor
 RelSpeedSensor
 ```
+
+## Translational Components
+
+```@meta
+CurrentModule = ModelingToolkitStandardLibrary.Mechanical.Translational
+```
+
+### Translational Utils
+
+```@docs
+MechanicalPort
+```
+
+### Translational Core Components
+
+```@docs
+Mass
+Spring
+Damper
+Fixed
+```
+
+### Translational Sources
+
+```@docs
+Force
+Position
+Velocity
+Acceleration
+```
+
+### Translational Sensors
+
+```@docs
+ForceSensor
+PositionSensor
+AccelerationSensor
+```

docs/src/connectors/connections.md

@@ -90,16 +90,15 @@ As can be seen, this will give a 1 equation model matching our energy dissipatio
 
 ```@example connections
 using ModelingToolkitStandardLibrary.Electrical, ModelingToolkit, DifferentialEquations
+using ModelingToolkit: t_nounits as t
 using Plots
 
-@parameters t
-
 @named resistor = Resistor(R = 1)
 @named capacitor = Capacitor(C = 1)
 @named ground = Ground()
 
 eqs = [connect(capacitor.p, resistor.p)
-    connect(resistor.n, ground.g, capacitor.n)]
+       connect(resistor.n, ground.g, capacitor.n)]
 
 @named model = ODESystem(eqs, t; systems = [resistor, capacitor, ground])
 
@@ -139,7 +138,7 @@ const TV = ModelingToolkitStandardLibrary.Mechanical.Translational
 @named ground = TV.Fixed()
 
 eqs = [connect(damping.flange_a, body.flange)
-    connect(ground.flange, damping.flange_b)]
+       connect(ground.flange, damping.flange_b)]
 
 @named model = ODESystem(eqs, t; systems = [damping, body, ground])
 
@@ -172,7 +171,7 @@ const TP = ModelingToolkitStandardLibrary.Mechanical.TranslationalPosition
 @named ground = TP.Fixed(s_0 = 0)
 
 eqs = [connect(damping.flange_a, body.flange)
-    connect(ground.flange, damping.flange_b)]
+       connect(ground.flange, damping.flange_b)]
 
 @named model = ODESystem(eqs, t; systems = [damping, body, ground])
 
@@ -267,7 +266,7 @@ Let's define a quick function to simplify and solve the 2 different systems. Not
 ```@example connections
 function simplify_and_solve(damping, spring, body, ground)
     eqs = [connect(spring.flange_a, body.flange, damping.flange_a)
-        connect(spring.flange_b, damping.flange_b, ground.flange)]
+           connect(spring.flange_b, damping.flange_b, ground.flange)]
 
     @named model = ODESystem(eqs, t; systems = [ground, body, spring, damping])
 

docs/src/tutorials/custom_component.md

@@ -8,6 +8,7 @@ First, we need to make some imports.
 
 ```@example components
 using ModelingToolkit
+using ModelingToolkit: t_nounits as t
 using ModelingToolkitStandardLibrary.Electrical
 using ModelingToolkitStandardLibrary.Electrical: OnePort
 using OrdinaryDiffEq
@@ -35,18 +36,16 @@ end NonlinearResistor;
 this can almost be directly translated to the syntax of `ModelingToolkit`.
 
 ```@example components
-@parameters t
-
 function NonlinearResistor(; name, Ga, Gb, Ve)
     @named oneport = OnePort()
     @unpack v, i = oneport
     pars = @parameters Ga=Ga Gb=Gb Ve=Ve
     eqs = [
         i ~ ifelse(v < -Ve,
-            Gb * (v + Ve) - Ga * Ve,
-            ifelse(v > Ve,
-                Gb * (v - Ve) + Ga * Ve,
-                Ga * v)),
+        Gb * (v + Ve) - Ga * Ve,
+        ifelse(v > Ve,
+            Gb * (v - Ve) + Ga * Ve,
+            Ga * v))
     ]
     extend(ODESystem(eqs, t, [], pars; name = name), oneport)
 end
@@ -102,14 +101,14 @@ The final model can now be created with the components from the library and the
 @named Gnd = Ground()
 
 connections = [connect(L.p, G.p)
-    connect(G.n, Nr.p)
-    connect(Nr.n, Gnd.g)
-    connect(C1.p, G.n)
-    connect(L.n, Ro.p)
-    connect(G.p, C2.p)
-    connect(C1.n, Gnd.g)
-    connect(C2.n, Gnd.g)
-    connect(Ro.n, Gnd.g)]
+               connect(G.n, Nr.p)
+               connect(Nr.n, Gnd.g)
+               connect(C1.p, G.n)
+               connect(L.n, Ro.p)
+               connect(G.p, C2.p)
+               connect(C1.n, Gnd.g)
+               connect(C2.n, Gnd.g)
+               connect(Ro.n, Gnd.g)]
 
 @named model = ODESystem(connections, t, systems = [L, Ro, G, C1, C2, Nr, Gnd])
 nothing # hide
@@ -132,7 +131,7 @@ Plots.savefig("chua_phase_plane.png")
 nothing # hide
 
 Plots.plot(sol; idxs = [C1.v, C2.v, L.i],
-    labels = ["C1 Voltage in V" "C1 Voltage in V" "Inductor Current in A"])
+    labels = ["C1 Voltage in V" "C2 Voltage in V" "Inductor Current in A"])
 Plots.savefig("chua.png")
 nothing # hide
 ```