Upgrade Manifolds.jl to ManifoldsBase 0.13

.github/workflows/ci.yml

@@ -7,12 +7,15 @@ on:
 
 jobs:
   test:
-    name: Julia ${{ matrix.julia-version }} - ${{ matrix.os }}
+    name: Julia ${{ matrix.julia-version }} - ${{ matrix.group }} - ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        julia-version: ["1.5", "1.6", "~1.7.0-0"]
+        julia-version: ["1.6", "1.7"]
         os: [ubuntu-latest, macOS-latest]
+        group:
+          - 'test_manifolds'
+          - 'test_lie_groups'
     steps:
       - uses: actions/checkout@v2
       - uses: julia-actions/setup-julia@v1
@@ -23,6 +26,7 @@ jobs:
       - uses: julia-actions/julia-runtest@latest
         env:
           PYTHON: ""
+          MANIFOLDS_TEST_GROUP: ${{ matrix.group }}
       - uses: julia-actions/julia-processcoverage@v1
       - uses: codecov/codecov-action@v1
         with:

.github/workflows/clear_preview.yml

@@ -1,4 +1,4 @@
-name: Documentation Preview Cleanup
+name: Doc Preview Cleanup
 
 on:
   pull_request:
@@ -12,17 +12,15 @@ jobs:
         uses: actions/checkout@v2
         with:
           ref: gh-pages
-
-      - name: Delete preview and history
+      - name: Delete preview and history + push changes
         run: |
-            git config user.name "Documenter.jl"
-            git config user.email "[email protected]"
-            git rm -rf "previews/PR$PRNUM"
-            git commit -m "delete preview"
-            git branch gh-pages-new $(echo "delete history" | git commit-tree HEAD^{tree})
+            if [ -d "previews/PR$PRNUM" ]; then
+              git config user.name "Documenter.jl"
+              git config user.email "[email protected]"
+              git rm -rf "previews/PR$PRNUM"
+              git commit -m "delete preview"
+              git branch gh-pages-new $(echo "delete history" | git commit-tree HEAD^{tree})
+              git push --force origin gh-pages-new:gh-pages
+            fi
         env:
-            PRNUM: ${{ github.event.number }}
-
-      - name: Push changes
-        run: |
-            git push --force origin gh-pages-new:gh-pages
+            PRNUM: ${{ github.event.number }}

.github/workflows/nightly.yml

@@ -4,12 +4,15 @@ on:
 
 jobs:
   test:
-    name: Julia nightly - ${{ matrix.os }}
+    name: Julia nightly - ${{ matrix.group }} - ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macOS-latest, windows-latest]
+        group:
+          - 'test_manifolds'
+          - 'test_lie_groups'
     steps:
       - uses: actions/checkout@v2
       - uses: julia-actions/setup-julia@v1
@@ -20,3 +23,4 @@ jobs:
       - uses: julia-actions/julia-runtest@latest
         env:
           PYTHON: ""
+          MANIFOLDS_TEST_GROUP: ${{ matrix.group }}

CONTRIBUTING.md

@@ -38,7 +38,7 @@ Even providing a single new method is a good contribution.
 
 A main contribution you can provide is another manifold that is not yet included in the
 package.
-A manifold is a concrete type of [`AbstractManifold`](https://juliamanifolds.github.io/Manifolds.jl/latest/interface.html#ManifoldsBase.AbstractManifold) from [`ManifoldsBase.jl`](https://juliamanifolds.github.io/Manifolds.jl/latest/interface.html).
+A manifold is a concrete type of [`AbstractManifold`](https://juliamanifolds.github.io/ManifoldsBase.jl/stable/types.html#ManifoldsBase.AbstractManifold)  from [`ManifoldsBase.jl`](https://juliamanifolds.github.io/Manifolds.jl/latest/interface.html).
 This package also provides the main set of functions a manifold can/should implement.
 Don't worry if you can only implement some of the functions.
 If the application you have in mind only requires a subset of these functions, implement those.
@@ -49,7 +49,7 @@ See for example [exp!](https://juliamanifolds.github.io/Manifolds.jl/latest/inte
 The non-mutating one (e.g. `exp`) always falls back to use the mutating one, so in most cases it should
 suffice to implement the mutating one (e.g. `exp!`).
 
-Note that since the first argument is _always_ the [`AbstractManifold`](https://juliamanifolds.github.io/Manifolds.jl/latest/interface.html#ManifoldsBase.AbstractManifold), the mutated argument is always the second one in the signature.
+Note that since the first argument is _always_ the [`AbstractManifold`](https://juliamanifolds.github.io/ManifoldsBase.jl/stable/types.html#ManifoldsBase.AbstractManifold) , the mutated argument is always the second one in the signature.
 In the example we have `exp(M, p, X)` for the exponential map and `exp!(M, q, X, p)` for the mutating one, which stores the result in `q`.
 
 On the other hand, the user will most likely look for the documentation of the non-mutating version, so we recommend adding the docstring for the non-mutating one, where all different signatures should be collected in one string when reasonable.

Project.toml

@@ -31,7 +31,7 @@ FiniteDiff = "2"
 Graphs = "1.4"
 HybridArrays = "0.4"
 Kronecker = "0.4, 0.5"
-ManifoldsBase = "0.12.13"
+ManifoldsBase = "0.13"
 Plots = "1"
 RecipesBase = "1.1"
 RecursiveArrayTools = "2"
@@ -40,7 +40,7 @@ SimpleWeightedGraphs = "1.2"
 SpecialFunctions = "0.8, 0.9, 0.10, 1.0, 2"
 StaticArrays = "1.0"
 StatsBase = "0.32, 0.33"
-julia = "1.5"
+julia = "1.6"
 
 [extras]
 Colors = "5ae59095-9a9b-59fe-a467-6f913c188581"

README.md

@@ -1,5 +1,5 @@
 <div align="center">
-    <img src="https://github.com/JuliaManifolds/Manifolds.jl/blob/master/docs/src/assets/logo-text-readme.png" alt="Manifolds.jl" width="526">
+    <img src="https://github.com/JuliaManifolds/Manifolds.jl/blob/master/docs/src/assets/logo-text-readme.png" alt="Manifolds.jl Logo with text" width="526">
 </div>
 
 | **Documentation** | **Source** | **Citation** |
@@ -21,8 +21,8 @@ To install the package just type
 ] add Manifolds
 ```
 
-Then you can directly start, for example to stop half way from the north pole on the [`Sphere`](https://juliamanifolds.github.io/Manifolds.jl/stable/manifolds/sphere.html) to a point on the equator, you can generate the [`shortest_geodesic`](https://juliamanifolds.github.io/Manifolds.jl/stable/interface.html#ManifoldsBase.shortest_geodesic-Tuple{AbstractManifold,Any,Any}).
-It internally employs [`exp`](https://juliamanifolds.github.io/Manifolds.jl/latest/interface.html#Base.exp-Tuple{AbstractManifold,Any,Any}) and [`log`](https://juliamanifolds.github.io/Manifolds.jl/latest/interface.html#Base.log-Tuple{AbstractManifold,Any,Any}).
+Then you can directly start, for example to stop half way from the north pole on the [`Sphere`](https://juliamanifolds.github.io/Manifolds.jl/stable/manifolds/sphere.html) to a point on the equator, you can generate the [`shortest_geodesic`](https://juliamanifolds.github.io/ManifoldsBase.jl/stable/functions.html#ManifoldsBase.shortest_geodesic-Tuple{AbstractManifold,%20Any,%20Any}).
+It internally employs [`exp`](https://juliamanifolds.github.io/ManifoldsBase.jl/stable/functions.html#Base.exp-Tuple{AbstractManifold,%20Any,%20Any}) and [`log`](https://juliamanifolds.github.io/ManifoldsBase.jl/stable/functions.html#Base.log-Tuple{AbstractManifold,%20Any,%20Any}).
 
 ```julia
 using Manifolds

assets/retraction_illustration.jl

@@ -95,7 +95,7 @@ push!(
 )
 push!(
     tp,
-    raw"\node[label ={[label distance=.05cm]below:{\color{gray}$q=\exp_pX$}}] at (axis cs:" *
+    raw"\node[label ={[label distance=.05cm]left:{\color{gray}$q=\exp_pX$}}] at (axis cs:" *
     "$(real(qE)),$(imag(qE))) {};",
 )
 

docs/Project.toml

@@ -15,11 +15,11 @@ StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [compat]
-Documenter = "0.24, 0.25, 0.26, 0.27"
+Documenter = "0.27"
 FiniteDifferences = "0.12"
 Graphs = "1.4"
 HybridArrays = "0.4"
-ManifoldsBase = "0.12.9"
+ManifoldsBase = "0.13"
 Plots = "1"
 PyPlot = "2.9"
 StaticArrays = "1.0"

docs/make.jl

@@ -26,13 +26,11 @@ end
 makedocs(
     # for development, we disable prettyurls
     format=Documenter.HTML(prettyurls=false, assets=["assets/favicon.ico"]),
-    modules=[Manifolds, ManifoldsBase],
+    modules=[Manifolds],
     authors="Seth Axen, Mateusz Baran, Ronny Bergmann, and contributors.",
     sitename="Manifolds.jl",
     pages=[
         "Home" => "index.md",
-        "ManifoldsBase.jl" => "interface.md",
-        "Examples" => ["How to implement a Manifold" => "examples/manifold.md"],
         "Manifolds" => [
             "Basic manifolds" => [
                 "Centered matrices" => "manifolds/centeredmatrices.md",