Skip to content

Commit

Permalink
Initial commit.
Browse files Browse the repository at this point in the history
  • Loading branch information
kellertuer committed Mar 27, 2024
0 parents commit 598161c
Show file tree
Hide file tree
Showing 4 changed files with 45 additions and 0 deletions.
23 changes: 23 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
The ManifoldExamples.jl package is licensed under the MIT "Expat" License:

> Copyright (c) 2024:
> * Ronny Bergmann <[email protected]>
>
> 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.
>
4 changes: 4 additions & 0 deletions Project.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
name = "ManifoldExamples"
uuid = "21be47e3-92bf-4199-8515-27870869dcc6"
authors = ["Ronny Bergmann <[email protected]>"]
version = "0.1.0"
15 changes: 15 additions & 0 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -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
3 changes: 3 additions & 0 deletions src/ManifoldExamples.jl
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module ManifoldExamples

end # module ManifoldExamples

0 comments on commit 598161c

Please sign in to comment.