Removal of dependency on SciMLBase.ODESolution (#33)

* First part of removal of dependency on `SciMLBase.ODESolution` * Mostly done I hope? * maybe fix? * Is v1 good? * Farewell, Julia 1.6 * OrdinaryDiffEq is still a test dependency * build docs on Julia 1.10 * fewer things in `ManifoldODESolution` * some documentation changes, export a few things * docs and minor improvements * a few more tests * add news * Apply suggestions from code review Co-authored-by: Ronny Bergmann <[email protected]> * improve docs --------- Co-authored-by: Ronny Bergmann <[email protected]>
JuliaManifolds · Sep 3, 2024 · 48a0cf1 · 48a0cf1
1 parent af86f91
commit 48a0cf1
Show file tree

Hide file tree

Showing 15 changed files with 808 additions and 125 deletions.
diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml
@@ -0,0 +1,12 @@
+name: Check Changelog
+on:
+  pull_request:
+
+jobs:
+  Check-Changelog:
+    name: Check Changelog Action
+    runs-on: ubuntu-latest
+    steps:
+      - uses: tarides/changelog-check-action@v3
+        with:
+          changelog: NEWS.md
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -11,7 +11,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        julia-version: ["1.6", "1.10", "~1.11.0-0"]
+        julia-version: ["1.10", "~1.11.0-0"]
         os: [ubuntu-latest, macOS-latest, windows-latest]
     steps:
       - uses: actions/checkout@v4

diff --git a/.github/workflows/documenter.yml b/.github/workflows/documenter.yml
@@ -14,7 +14,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@latest
         with:
-          version: 1.6
+          version: "1.10"
       - uses: julia-actions/julia-docdeploy@v1
         env:
           PYTHON: ""

diff --git a/Project.toml b/Project.toml
@@ -1,29 +1,35 @@
 name = "ManifoldDiffEq"
 uuid = "1143c485-9b25-4e23-a65f-701df382ec90"
 authors = ["Seth Axen <[email protected]>", "Mateusz Baran <[email protected]>", "Ronny Bergmann <[email protected]>", "Antoine Levitt <[email protected]>"]
-version = "0.1.9"
+version = "0.2.0"
 
 [deps]
+Accessors = "7d9f7c33-5ae7-4f3b-8dc6-eff91059b697"
+ConstructionBase = "187b0558-2788-49d3-abe0-74a17ed4e7c9"
 DiffEqBase = "2b5f629d-d688-5b77-993f-72d75c75574e"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 Manifolds = "1cead3c2-87b3-11e9-0ccd-23c62b72b94e"
 ManifoldsBase = "3362f125-f0bb-47a3-aa74-596ffd7ef2fb"
 Markdown = "d6f4376e-aef5-505a-96c1-9c027394607a"
-OrdinaryDiffEq = "1dea7af3-3e70-54e6-95c3-0bf5283fa5ed"
+OrdinaryDiffEqCore = "bbf590c4-e513-4bbe-9b18-05decba2e5d8"
 RecursiveArrayTools = "731186ca-8d62-57ce-b412-fbd966d074cd"
 SciMLBase = "0bca4576-84f4-4d90-8ffe-ffa030f20462"
+SimpleUnPack = "ce78b400-467f-4804-87d8-8f486da07d0a"
 
 [compat]
+Accessors = "0.1"
+ConstructionBase = "1"
 DiffEqBase = "6"
 DoubleFloats = ">= 0.9.2"
 LinearAlgebra = "1.6"
 Manifolds = "0.10"
 ManifoldsBase = "0.15"
 Markdown = "1.6"
-OrdinaryDiffEq = "6"
+OrdinaryDiffEqCore = "1"
 RecursiveArrayTools = "2, 3"
-SciMLBase = "1.0, 2 - 2.39"
-julia = "1.6"
+SciMLBase = "1, 2"
+SimpleUnPack = "1"
+julia = "1.10"
 
 [extras]
 DoubleFloats = "497a8b3b-efae-58df-a0af-a86822472b78"

diff --git a/docs/make.jl b/docs/make.jl
@@ -21,6 +21,7 @@ makedocs(
         "Error estimation" => "error_estimation.md",
         "Notation" => "notation.md",
         "Examples" => "examples.md",
+        "Internals" => "internals.md",
         "References" => "references.md",
     ],
     plugins = [bib],

diff --git a/docs/src/examples.md b/docs/src/examples.md
@@ -2,7 +2,7 @@
 
 We take a look at the simple example from
 
-In the following code an ODE on a sphere is solved the introductionary example from the
+In the following code an ODE on a sphere is solved the introductory example from the
 [lecture notes](https://www.unige.ch/~hairer/poly-sde-mani.pdf) by [E. Hairer](http://www.unige.ch/~hairer/).
 
 We solve the ODE system on the sphere ``\mathbb S^2`` given by
@@ -27,7 +27,7 @@ We solve the ODE system on the sphere ``\mathbb S^2`` given by
 ```
 
 ```julia
-using ManifoldDiffEq, OrdinaryDiffEq, Manifolds
+using ManifoldDiffEq, Manifolds
 using GLMakie, LinearAlgebra, Colors
 
 n = 25
@@ -72,15 +72,15 @@ S2 = Manifolds.Sphere(2)
 u0 = [0.0, sqrt(9/10), sqrt(1/10)]
 tspan = (0, 20.0)
 
-A_lie = ManifoldDiffEq.LieManifoldDiffEqOperator{Float64}() do u, p, t
+A_lie = LieManifoldDiffEqOperator{Float64}() do u, p, t
     return hat(SpecialOrthogonal(3), Matrix(I(3)), cross(u, f2(u...)))
 end
-prob_lie = ManifoldDiffEq.ManifoldODEProblem(A_lie, u0, tspan, S2)
+prob_lie = ManifoldODEProblem(A_lie, u0, tspan, S2)
 
-A_frozen = ManifoldDiffEq.FrozenManifoldDiffEqOperator{Float64}() do u, p, t
+A_frozen = FrozenManifoldDiffEqOperator{Float64}() do u, p, t
     return f2(u...)
 end
-prob_frozen = ManifoldDiffEq.ManifoldODEProblem(A_frozen, u0, tspan, S2)
+prob_frozen = ManifoldODEProblem(A_frozen, u0, tspan, S2)
 
 action = RotationAction(Euclidean(3), SpecialOrthogonal(3))
 alg_lie_euler = ManifoldDiffEq.ManifoldLieEuler(S2, ExponentialRetraction(), action)

diff --git a/docs/src/internals.md b/docs/src/internals.md
@@ -0,0 +1,12 @@
+# Internal documentation
+
+This page documents the internal types and methods of `ManifoldDiffEq.jl`.
+
+## Functions
+
+```@docs
+ManifoldDiffEq.AbstractManifoldDiffEqAlgorithm
+ManifoldDiffEq.ManifoldInterpolationData
+ManifoldDiffEq.AbstractManifoldDiffEqAdaptiveAlgorithm
+ManifoldDiffEq.ManifoldODESolution
+```