Fix example and add SciMLOperators v0.4 compatibility (#42)

* fix example and update SciMLOperators compat

* fix manifold

Author: mateuszbaran

NEWS.md

@@ -5,6 +5,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.2.5] - 2025-10-18
+
+### Added
+
+* Compatibility with SciMLOperators v0.4
+
+### Fixed
+
+* Example usage was updated to the `LieGroups.jl` refactor.
+
 ## [0.2.4] - 2025-10-09
 
 ### Changed

Project.toml

@@ -1,6 +1,6 @@
 name = "ManifoldDiffEq"
 uuid = "1143c485-9b25-4e23-a65f-701df382ec90"
-version = "0.2.4"
+version = "0.2.5"
 authors = ["Seth Axen <[email protected]>", "Mateusz Baran <[email protected]>", "Ronny Bergmann <[email protected]>", "Antoine Levitt <[email protected]>"]
 
 [deps]
@@ -31,7 +31,7 @@ Markdown = "1.6"
 OrdinaryDiffEqCore = "1"
 RecursiveArrayTools = "2, 3"
 SciMLBase = "1, 2"
-SciMLOperators = "0.3.13"
+SciMLOperators = "0.3.13, 0.4"
 SimpleUnPack = "1"
 julia = "1.10"
 

docs/make.jl

@@ -17,7 +17,7 @@ links = InterLinks(
 makedocs(
     # for development, we disable prettyurls
     format = Documenter.HTML(
-        prettyurls = false,
+        prettyurls = (get(ENV, "CI", nothing) == "true"),
         assets = ["assets/favicon.ico", "assets/citations.css"],
     ),
     modules = [ManifoldDiffEq],

docs/src/examples.md

@@ -27,7 +27,7 @@ We solve the ODE system on the sphere ``\mathbb S^2`` given by
 ```
 
 ```julia
-using ManifoldDiffEq, Manifolds
+using ManifoldDiffEq, Manifolds, LieGroups
 using GLMakie, LinearAlgebra, Colors
 
 n = 25
@@ -59,6 +59,7 @@ arr = GLMakie.arrows!(
 )
 save("docs/src/assets/img/first_example_vector_field.png", f)
 ```
+
 which looks like
 
 ![The ODE illustrated as a tangent vector field](assets/img/first_example_vector_field.png)
@@ -73,7 +74,7 @@ u0 = [0.0, sqrt(9/10), sqrt(1/10)]
 tspan = (0, 20.0)
 
 A_lie = LieManifoldDiffEqOperator{Float64}() do u, p, t
-    return hat(SpecialOrthogonal(3), Matrix(I(3)), cross(u, f2(u...)))
+    return hat(SpecialOrthogonalGroup(3), Matrix(I(3)), cross(u, f2(u...)))
 end
 prob_lie = ManifoldODEProblem(A_lie, u0, tspan, S2)
 
@@ -82,9 +83,9 @@ A_frozen = FrozenManifoldDiffEqOperator{Float64}() do u, p, t
 end
 prob_frozen = ManifoldODEProblem(A_frozen, u0, tspan, S2)
 
-action = RotationAction(Euclidean(3), SpecialOrthogonal(3))
-alg_lie_euler = ManifoldDiffEq.ManifoldLieEuler(S2, ExponentialRetraction(), action)
-alg_lie_rkmk4 = ManifoldDiffEq.RKMK4(S2, ExponentialRetraction(), action)
+action = GroupAction(LeftMultiplicationGroupAction(), SpecialOrthogonalGroup(3), S2)
+alg_lie_euler = ManifoldDiffEq.ManifoldLieEuler(ExponentialRetraction(), action)
+alg_lie_rkmk4 = ManifoldDiffEq.RKMK4(ExponentialRetraction(), action)
 
 alg_manifold_euler = ManifoldDiffEq.ManifoldEuler(S2, ExponentialRetraction())
 alg_cg2 = ManifoldDiffEq.CG2(S2, ExponentialRetraction())