Awesome
<div align="center"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://github.com/JuliaManifolds/ManifoldsBase.jl/raw/master/docs/src/assets/logo-text-readme-dark.png"> <img alt="ManifoldsBase.jl logo with text on the side" src="https://github.com/JuliaManifolds/ManifoldsBase.jl/raw/master/docs/src/assets/logo-text-readme.png"> </picture> </div>Installation
In Julia you can install this package by typing
using Pkg; Pkg.add("ManifoldsBase")
in the Julia REPL.
Since this package provides an interface, you probably either want to add it as a dependency to your project/package to work on manifold generically or implement a new manifold.
A package that (only) depends on ManifoldsBase.jl
, see Manopt.jl, which implements optimization algorithms on manifolds using this interface, i.e. they can be used with any manifold based on ManifoldsBase.jl
. A library of manifolds implemented using this interface is provided see Manifolds.jl.
Your package is using ManifoldsBase
?
We would be very interested to hear where you are using the interface or manifolds in general! Give us a note and we add you here.
Citation
If you use ManifoldsBase.jl
in your work, please cite the following open access article
@article{AxenBaranBergmannRzecki:2023,
author = {Axen, Seth D. and Baran, Mateusz and Bergmann, Ronny and Rzecki, Krzysztof},
articleno = {33},
doi = {10.1145/3618296},
journal = {ACM Transactions on Mathematical Software},
month = {dec},
number = {4},
title = {Manifolds.Jl: An Extensible Julia Framework for Data Analysis on Manifolds},
volume = {49},
year = {2023},
}
To refer to a certain version we recommend to also cite for example
@software{manifoldsbasejl-zenodo-mostrecent,
AUTHOR = {Seth D. Axen and Mateusz Baran and Ronny Bergmann},
TITLE = {ManifoldsBase.jl},
DOI = {10.5281/ZENODO.5964340},
URL = {https://zenodo.org/record/5964340},
PUBLISHER = {Zenodo},
YEAR = {2022},
COPYRIGHT = {MIT License}
}
Note that both citations are in BibLaTeX format.