From 598161c3f04b9d71f3d1a84f5ffe8b6a6d842d99 Mon Sep 17 00:00:00 2001 From: Ronny Bergmann Date: Wed, 27 Mar 2024 13:36:46 +0100 Subject: [PATCH] Initial commit. --- LICENSE | 23 +++++++++++++++++++++++ Project.toml | 4 ++++ Readme.md | 15 +++++++++++++++ src/ManifoldExamples.jl | 3 +++ 4 files changed, 45 insertions(+) create mode 100644 LICENSE create mode 100644 Project.toml create mode 100644 Readme.md create mode 100644 src/ManifoldExamples.jl diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..3ef080a --- /dev/null +++ b/LICENSE @@ -0,0 +1,23 @@ +The ManifoldExamples.jl package is licensed under the MIT "Expat" License: + +> Copyright (c) 2024: +> * Ronny Bergmann +> +> Permission is hereby granted, free of charge, to any person obtaining a copy +> of this software and associated documentation files (the "Software"), to deal +> in the Software without restriction, including without limitation the rights +> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +> copies of the Software, and to permit persons to whom the Software is +> furnished to do so, subject to the following conditions: +> +> The above copyright notice and this permission notice shall be included in all +> copies or substantial portions of the Software. +> +> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +> SOFTWARE. +> diff --git a/Project.toml b/Project.toml new file mode 100644 index 0000000..a389c7d --- /dev/null +++ b/Project.toml @@ -0,0 +1,4 @@ +name = "ManifoldExamples" +uuid = "21be47e3-92bf-4199-8515-27870869dcc6" +authors = ["Ronny Bergmann "] +version = "0.1.0" diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..55f32aa --- /dev/null +++ b/Readme.md @@ -0,0 +1,15 @@ +# ManifoldExamples.jl + +[![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle) + +This package is a work in progress repository to host examples working with [Manifolds.jl](https://juliamanifolds.github.io/Manifolds.jl/) and accompanying code, illustrating the use of `Manifolds.jl` in reproducible [Quarto](https://quarto.org) notebooks. + +Note that this package is not meant to introduce new manifolds themselves; these should be part of [Manifolds.jl](https://juliamanifolds.github.io/Manifolds.jl/) themselves, but focusses on applications where the manifolds are used numerically + +A similar package providing reference implementations and example for [Manopt.jl](https://manoptjl.org/) optimisation problems, see {ManoptExamples.jl}(https://juliamanifolds.github.io/ManoptExamples.jl/). + +The next steps here are + +* Setup the documentation environment including rendering of Quarto notebooks +* setup the GitHub Action based CI for rendering +* add a changelog and a first example \ No newline at end of file diff --git a/src/ManifoldExamples.jl b/src/ManifoldExamples.jl new file mode 100644 index 0000000..56b18b9 --- /dev/null +++ b/src/ManifoldExamples.jl @@ -0,0 +1,3 @@ +module ManifoldExamples + +end # module ManifoldExamples