dnguyend / manifolds.jl Goto Github PK

Documentation	Source	Citation

Package Manifolds.jl aims to provide both a unified interface to define and use manifolds as well as a library of manifolds to use for your projects. This package is under development, and subject to changes as needed.

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 to a point on the equator, you can generate the shortest_geodesic. It internally employs exp and log.

using Manifolds
M = Sphere(2)
γ = shortest_geodesic(M, [0., 0., 1.], [0., 1., 0.])
γ(0.5)

If you use Manifolds.jl in your work, please cite the following

@online{2106.08777,
  Author = {Seth D. Axen and Mateusz Baran and Ronny Bergmann and Krzysztof Rzecki},
  Title = {Manifolds.jl: An Extensible {J}ulia Framework for Data Analysis on Manifolds},
  Year = {2021},
  Eprint = {2106.08777},
  Eprinttype = {arXiv},
}

To refer to a certain version we recommend to also cite for example

@software{manifoldsjl-zenodo-mostrecent,
  Author = {Seth D. Axen and Mateusz Baran and Ronny Bergmann},
  Title = {Manifolds.jl},
  Doi = {10.5281/ZENODO.4292129},
  Url = {https://zenodo.org/record/4292129},
  Publisher = {Zenodo},
  Year = {2021},
  Copyright = {MIT License}
}

for the most recent version or a corresponding version specific DOI, see the list of all versions. Note that both citations are in BibLaTeX format.