JuliaManifolds / ManoptExamples.jl

🏔️⛷️ ManoptExamples.jl – A collection of research and tutorial example problems for Manopt.jl

ManoptExamples.jl

This package provides examples of optimizations problems on Riemannian manifolds.

It uses the manifolds from Manifolds.jl and the structures provided by Manopt.jl. to state the problems. Furthermore the problems are illustrated in their usage in Quarto Markdown files, that are pre-rendered into the documentation. This way, the package also provides examples of the provided examples “in action”.

Citation

If you use ManoptExamples.jl in your work, please cite Manopt.jl, i.e. the following

@article{Bergmann2022,
    Author    = {Ronny Bergmann},
    Doi       = {10.21105/joss.03866},
    Journal   = {Journal of Open Source Software},
    Number    = {70},
    Pages     = {3866},
    Publisher = {The Open Journal},
    Title     = {Manopt.jl: Optimization on Manifolds in {J}ulia},
    Volume    = {7},
    Year      = {2022},
}

To refer to a certain version or the source code in general we recommend to cite for example

@software{manoptjl-zenodo-mostrecent,
    Author = {Ronny Bergmann},
    Copyright = {MIT License},
    Doi = {10.5281/zenodo.4290905},
    Publisher = {Zenodo},
    Title = {Manopt.jl},
    Year = {2023},
}

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.

Similarly this package has a zenodo DOI, for example

@software{manoptjl-zenodo-mostrecent,
    Author = {Ronny Bergmann},
    Copyright = {MIT License},
    Doi = {10.5281/zenodo.7662431},
    Publisher = {Zenodo},
    Title = {ManoptExamples.jl},
    Year = {2023},
}