diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index aaf0a98..a5bba87 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,26 +31,23 @@ Currently we are still consolidating most details and defaults, but feel free to ## Code style Try to follow the [documentation guidelines](https://docs.julialang.org/en/v1/manual/documentation/) from the Julia documentation as well as [Blue Style](https://github.com/invenia/BlueStyle). -Run [`JuliaFormatter.jl`](https://github.com/domluna/JuliaFormatter.jl) on the repository in the way set in the `.JuliaFormatter.toml` file, which enforces a number of conventions consistent with the Blue Style. Furthermore [vale](https://vale.sh) is run on both Markdown and code files, affecting documentation and source code comments +Run [`JuliaFormatter.jl`](https://github.com/domluna/JuliaFormatter.jl) on the repository in the way set in the `.JuliaFormatter.toml` file, which enforces a number of conventions consistent with the Blue Style. Please follow a few internal conventions: -- It is preferred that the `AbstractManoptProblem`'s struct contains information about the general structure of the problem. - Any implemented function should be accompanied by its mathematical formulae if a closed form exists. -- `AbstractManoptProblem` and helping functions are stored within the `plan/` folder and sorted by properties of the problem and/or solver at hand. -- the solver state is usually stored with the solver itself -- Within the source code of one algorithm, following the state, the high level interface should be next, then the initialization, then the step. -- Otherwise an alphabetical order of functions is preferable. +- A Lie group, a Lie group action or a Lie algebra should be implemented in it own file +- an alphabetical order of functions in every file is preferable. - The preceding implies that the mutating variant of a function follows the non-mutating variant. +- usually, both the allocating and the mutating variants of a function should be documented. For avoiding duplication, one doc string attached to both is preferrable - There should be no dangling `=` signs. - Always add a newline between things of different types (struct/method/const). -- Always add a newline between methods for different functions (including mutating/nonmutating variants). +- Always add a newline between methods for different functions (including allocating/mutating variants). - Prefer to have no newline between methods for the same function; when reasonable, merge the documentation strings. - All `import`/`using`/`include` should be in the main module file. +- `import` is discouraged and the explicit full name, like `Base.exp` should be used when implementing functions Concerning documentation - if possible provide both mathematical formulae and literature references using [DocumenterCitations.jl](https://juliadocs.org/DocumenterCitations.jl/stable/) and BibTeX where possible -- Always document all input variables and keyword arguments - -If you implement an algorithm with a certain numerical example in mind, it would be great, if this could be added to the [ManoptExamples.jl](https://github.com/JuliaManifolds/ManoptExamples.jl) package as well. \ No newline at end of file +- Always document all input variables and keyword arguments \ No newline at end of file diff --git a/Readme.md b/Readme.md index 3c8bff7..f168c80 100644 --- a/Readme.md +++ b/Readme.md @@ -5,10 +5,13 @@ +[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://juliamanifolds.github.io/Manifolds.jl/latest/) +[![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle) [![CI](https://github.com/JuliaManifolds/LieGroups.jl/actions/workflows/ci.yml/badge.svg)](https://github.com/JuliaManifolds/LieGroups.jl/actions?query=workflow%3ACI+branch%3Amain) [![codecov.io](http://codecov.io/github/JuliaManifolds/LieGroups.jl/coverage.svg?branch=main)](https://codecov.io/gh/JuliaManifolds/LieGroups.jl/) + This is a package to rework the Lie group features of [`Manifolds.jl`](https://juliamanifolds.github.io/Manifolds.jl/stable/) in a unified way into a separate package. This especially also includes a few different choices in default behabiour that -is different from the `Manifolds.jl` one. For purely manifold-based operations, any Lie group still is “build upon” a Riemannian manifold. +is different from the [`Manifolds.jl`](https://juliamanifolds.github.io/Manifolds.jl/stable/) one. For purely manifold-based operations, any Lie group still is “build upon” a Riemannian manifold. -See [#1](https://github.com/JuliaManifolds/LieGroups.jl/issues/1) for an overview of fatures that are plannned. -Feel free to add to this list with opening further issues. \ No newline at end of file +See [#5](https://github.com/JuliaManifolds/LieGroups.jl/issues/5) for an overview of fatures that are plannned. +Feel free to add to this list with opening further issues. diff --git a/assets/logo-dark.pdf b/assets/logo-dark.pdf index 8ebcbf6..b5f39e2 100644 Binary files a/assets/logo-dark.pdf and b/assets/logo-dark.pdf differ diff --git a/assets/logo-dark.svg b/assets/logo-dark.svg index a7d31ab..e4f12f8 100644 --- a/assets/logo-dark.svg +++ b/assets/logo-dark.svg @@ -316,7 +316,7 @@ - + @@ -386,7 +386,7 @@ - + @@ -456,7 +456,7 @@ - + diff --git a/assets/logo-lie.jl b/assets/logo-lie.jl index ef608df..2cc3d19 100644 --- a/assets/logo-lie.jl +++ b/assets/logo-lie.jl @@ -3,7 +3,7 @@ using Manifolds, LinearAlgebra, PGFPlotsX, Colors, Distributions, Contour, Rando # # Settings # -dark_mode = true +dark_mode = false line_offset_brightness = 0.25 patch_opacity = 1.0 @@ -136,8 +136,11 @@ rs = range(0, π / 5; length=6) # # Plot manifold patches -patch_colors = rgb_logo_colors[2:end] -patch_colors_line = dark_mode ? rgb_logo_colors_bright[2:end] : rgb_logo_colors_dark[2:end] +# rotate color indices +indices = [3, 4, 2] # original [2,3,4] +patch_colors = rgb_logo_colors[indices] +patch_colors_line = + dark_mode ? rgb_logo_colors_bright[indices] : rgb_logo_colors_dark[indices] base_points = [p1, p2, p3] basis_vectors = [log(S, p1, p2), log(S, p2, p1), log(S, p3, p1)] for i in eachindex(base_points) @@ -163,7 +166,7 @@ options = @pgf { roundcaps, line_width = geo_line_width, color = dark_mode ? "white" : "black", - "-{Stealth[length=6cm,sharp,bend=-9]}", #length=8mm,width=2mm,inset=3mm + "-{Stealth[length=6.195cm,sharp,bend=-9]}", #length=8mm,width=2mm,inset=3mm } plot_geodesic!(tp, S, base_points[1], base_points[2]; m=25, options=options) plot_geodesic!(tp, S, base_points[3], base_points[1]; m=25, options=options) diff --git a/assets/logo.pdf b/assets/logo.pdf index 06309c0..e32417b 100644 Binary files a/assets/logo.pdf and b/assets/logo.pdf differ diff --git a/assets/logo.svg b/assets/logo.svg index 5c14c97..2938035 100644 --- a/assets/logo.svg +++ b/assets/logo.svg @@ -260,31 +260,31 @@ - + - + - + - + - + @@ -296,13 +296,13 @@ - + - + @@ -310,7 +310,7 @@ - + @@ -380,7 +380,7 @@ - + @@ -450,7 +450,7 @@ - + @@ -520,47 +520,47 @@ - + - + - + - + - + - + - + - + - + diff --git a/docs/src/assets/android-chrome-192x192.png b/docs/src/assets/android-chrome-192x192.png index d056784..13b0572 100644 Binary files a/docs/src/assets/android-chrome-192x192.png and b/docs/src/assets/android-chrome-192x192.png differ diff --git a/docs/src/assets/android-chrome-512x512.png b/docs/src/assets/android-chrome-512x512.png index 78ccfca..73c276f 100644 Binary files a/docs/src/assets/android-chrome-512x512.png and b/docs/src/assets/android-chrome-512x512.png differ diff --git a/docs/src/assets/apple-touch-icon.png b/docs/src/assets/apple-touch-icon.png index cadab6b..2910eb2 100644 Binary files a/docs/src/assets/apple-touch-icon.png and b/docs/src/assets/apple-touch-icon.png differ diff --git a/docs/src/assets/favicon-16x16.png b/docs/src/assets/favicon-16x16.png index 6672c8c..4331a3b 100644 Binary files a/docs/src/assets/favicon-16x16.png and b/docs/src/assets/favicon-16x16.png differ diff --git a/docs/src/assets/favicon-32x32.png b/docs/src/assets/favicon-32x32.png index 25b9ea2..d3bbafe 100644 Binary files a/docs/src/assets/favicon-32x32.png and b/docs/src/assets/favicon-32x32.png differ diff --git a/docs/src/assets/favicon.ico b/docs/src/assets/favicon.ico index 9efdb1c..baf97b8 100644 Binary files a/docs/src/assets/favicon.ico and b/docs/src/assets/favicon.ico differ diff --git a/docs/src/assets/logo-dark.png b/docs/src/assets/logo-dark.png index 6bdb0fd..b569fd9 100644 Binary files a/docs/src/assets/logo-dark.png and b/docs/src/assets/logo-dark.png differ diff --git a/docs/src/assets/logo-dark_big.png b/docs/src/assets/logo-dark_big.png index 6d29e59..4f73668 100644 Binary files a/docs/src/assets/logo-dark_big.png and b/docs/src/assets/logo-dark_big.png differ diff --git a/docs/src/assets/logo.png b/docs/src/assets/logo.png index aa30ed2..dec1ef1 100644 Binary files a/docs/src/assets/logo.png and b/docs/src/assets/logo.png differ diff --git a/docs/src/assets/logo_big.png b/docs/src/assets/logo_big.png index 40b51f7..f1b06cf 100644 Binary files a/docs/src/assets/logo_big.png and b/docs/src/assets/logo_big.png differ diff --git a/docs/src/assets/logo_text.png b/docs/src/assets/logo_text.png index da79f44..3f05814 100644 Binary files a/docs/src/assets/logo_text.png and b/docs/src/assets/logo_text.png differ diff --git a/docs/src/assets/logo_text_dark.png b/docs/src/assets/logo_text_dark.png index a798898..53a96f3 100644 Binary files a/docs/src/assets/logo_text_dark.png and b/docs/src/assets/logo_text_dark.png differ diff --git a/docs/src/assets/logo_text_readme.png b/docs/src/assets/logo_text_readme.png index 3d1167a..43f2db2 100644 Binary files a/docs/src/assets/logo_text_readme.png and b/docs/src/assets/logo_text_readme.png differ diff --git a/docs/src/assets/logo_text_readme_dark.png b/docs/src/assets/logo_text_readme_dark.png index fc5c20f..bbfc3eb 100644 Binary files a/docs/src/assets/logo_text_readme_dark.png and b/docs/src/assets/logo_text_readme_dark.png differ diff --git a/docs/src/assets/safari-pinned-tab.svg b/docs/src/assets/safari-pinned-tab.svg deleted file mode 100644 index 91bf799..0000000 --- a/docs/src/assets/safari-pinned-tab.svg +++ /dev/null @@ -1,249 +0,0 @@ - - - - -Created by potrace 1.14, written by Peter Selinger 2001-2017 - - - - - - diff --git a/docs/src/assets/site.webmanifest b/docs/src/assets/site.webmanifest index b20abb7..45dc8a2 100644 --- a/docs/src/assets/site.webmanifest +++ b/docs/src/assets/site.webmanifest @@ -1,19 +1 @@ -{ - "name": "", - "short_name": "", - "icons": [ - { - "src": "/android-chrome-192x192.png", - "sizes": "192x192", - "type": "image/png" - }, - { - "src": "/android-chrome-512x512.png", - "sizes": "512x512", - "type": "image/png" - } - ], - "theme_color": "#ffffff", - "background_color": "#ffffff", - "display": "standalone" -} +{"name":"","short_name":"","icons":[{"src":"/android-chrome-192x192.png","sizes":"192x192","type":"image/png"},{"src":"/android-chrome-512x512.png","sizes":"512x512","type":"image/png"}],"theme_color":"#ffffff","background_color":"#ffffff","display":"standalone"} \ No newline at end of file