diff --git a/.zenodo.json b/.zenodo.json new file mode 100644 index 00000000..12bf286e --- /dev/null +++ b/.zenodo.json @@ -0,0 +1,44 @@ +{ + "description": "

The OptimalControlProblems.jl package is part of the control-toolbox ecosystem. The control-toolbox ecosystem gathers Julia packages for mathematical control and applications. The root package is OptimalControl.jl which aims to provide tools to model and solve optimal control problems with ordinary differential equations by direct and indirect methods, both on CPU and GPU.

", + "title": "OptimalControlProblems.jl: a collection of optimal control problems with ODE's in Julia", + "upload_type": "software", + "doi": "10.5281/zenodo.17013021", + "keywords": [ + "optimal control", + "control of ODE's", + "optimization", + "direct transcription", + "benchmark suite" + ], + "creators": [ + { + "affiliation": "Université Côte d’Azur, CNRS, Inria, LJAD", + "name": "Caillau, Jean-Baptiste", + "orcid": "0000-0002-1719-2016" + }, + { + "affiliation": "Université Toulouse, CNRS, ENSEEIHT-IRIT", + "name": "Cots, Olivier", + "orcid": "0000-0002-4703-4369" + }, + { + "affiliation": "Université Toulouse, CNRS, ENSEEIHT-IRIT", + "name": "Gergaud, Joseph", + "orcid": "0009-0005-9825-8652" + }, + { + "affiliation": "CAGE team, Inria Paris", + "name": "Martinon, Pierre", + "orcid": "0000-0003-0571-2376" + } + ], + "access_right": "open", + "related_identifiers": [ + { + "scheme": "url", + "identifier": "https://github.com/control-toolbox/OptimalControlProblems.jl/releases/latest", + "relation": "isSupplementTo" + } + ], + "license": "MIT" +} \ No newline at end of file diff --git a/CITATION.bib b/CITATION.bib new file mode 100644 index 00000000..3cfbfe34 --- /dev/null +++ b/CITATION.bib @@ -0,0 +1,7 @@ +@software{Caillau_OptimalControl_jl_a_Julia, +author = {Caillau, Jean-Baptiste and Cots, Olivier and Gergaud, Joseph and Martinon, Pierre}, +doi = {10.5281/zenodo.17013021}, +license = {["MIT"]}, +title = {{OptimalControlProblems.jl: a collection of optimal control problems with ODE's in Julia}}, +url = {https://control-toolbox.org/OptimalControlProblems.jl} +} \ No newline at end of file diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 00000000..f4fe5858 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,31 @@ +abstract:

The OptimalControlProblems.jl package is part of the control-toolbox ecosystem. The control-toolbox ecosystem gathers Julia packages for mathematical control and applications. The root package is OptimalControl.jl which aims to provide tools to model and solve optimal control problems with ordinary differential equations by direct and indirect methods, both on CPU and GPU.

+title: "OptimalControlProblems.jl: a collection of optimal control problems with ODE's in Julia" +authors: +- affiliation: "Universit\xE9 C\xF4te d'Azur, CNRS, Inria, LJAD" + family-names: Caillau + given-names: Jean-Baptiste + orcid: 0000-0002-1719-2016 +- affiliation: "Universit\xE9 Toulouse, CNRS, ENSEEIHT-IRIT" + family-names: Cots + given-names: Olivier + orcid: 0000-0002-4703-4369 +- affiliation: "Universit\xE9 Toulouse, CNRS, ENSEEIHT-IRIT" + family-names: Gergaud + given-names: Joseph + orcid: 0009-0005-9825-8652 +- affiliation: CAGE team, Inria Paris + family-names: Martinon + given-names: Pierre + orcid: 0000-0003-0571-2376 +cff-version: 1.2.0a +doi: 10.5281/zenodo.17013021 +keywords: +- optimal control +- control of ODE's +- optimization +- direct transcription +- benchmark suite +license: +- MIT +url: "https://control-toolbox.org/OptimalControlProblems.jl" +type: software \ No newline at end of file diff --git a/Project.toml b/Project.toml index 0233be85..cb55cd22 100644 --- a/Project.toml +++ b/Project.toml @@ -1,7 +1,7 @@ name = "OptimalControlProblems" uuid = "59046045-fb9c-4c23-964f-ff0a25704f96" authors = ["Olivier Cots "] -version = "0.2.1" +version = "0.2.2" [deps] ADNLPModels = "54578032-b7ea-4c30-94aa-7cbd1cce6c9a" diff --git a/README.md b/README.md index 05d2587a..9534b387 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,9 @@ [pkg-eval-img]: https://img.shields.io/badge/Julia-package-purple [pkg-eval-url]: https://juliahub.com/ui/Packages/General/OptimalControlProblems +[citation-img]: https://zenodo.org/badge/541187171.svg +[citation-url]: https://zenodo.org/doi/10.5281/zenodo.17013021 + [licence-img]: https://img.shields.io/badge/License-MIT-yellow.svg [licence-url]: https://github.com/control-toolbox/OptimalControlProblems.jl/blob/master/LICENSE @@ -35,6 +38,7 @@ The control-toolbox ecosystem gathers Julia packages for mathematical control an | Code Status | [![Build Status][ci-img]][ci-url] [![Covering Status][co-img]][co-url] [![pkgeval][pkg-eval-img]][pkg-eval-url] [![Code Style: Blue][blue-img]][blue-url] | | Licence | [![License: MIT][licence-img]][licence-url] | | Release | [![Release][release-img]][release-url] | +| Citation | [![DOI][citation-img]][citation-url] | ## Installation diff --git a/docs/src/index.md b/docs/src/index.md index 96fa86e4..5c72c32e 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -15,6 +15,36 @@ using Pkg Pkg.add("OptimalControlProblems") ``` +## Citing us + +If you use OptimalControlProblems.jl in your work, please cite us: + +> Caillau, J.-B., Cots, O., Gergaud, J., & Martinon, P. *OptimalControlProblems.jl: a collection of optimal control problems with ODE's in Julia*. [doi.org/10.5281/zenodo.17013021](https://doi.org/10.5281/zenodo.17013021) + +or in bibtex format: + +```bibtex +@software{Caillau_OptimalControlProblems_jl, +author = {Caillau, Jean-Baptiste and Cots, Olivier and Gergaud, Joseph and Martinon, Pierre}, +doi = {10.5281/zenodo.17013021}, +license = {["MIT"]}, +title = {{OptimalControlProblems.jl: a collection of optimal control problems with ODE's in Julia}}, +url = {https://control-toolbox.org/OptimalControlProblems.jl} +} +``` + +## Contributing + +If you think you found a bug or if you have a feature request / suggestion, feel free to open an [issue](https://github.com/control-toolbox/OptimalControlProblems.jl/issues). Before opening a pull request, please start an issue or a discussion on the topic. + +Contributions are welcomed, check out [how to contribute to a Github project](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project). If it is your first contribution, you can also check [this first contribution tutorial](https://github.com/firstcontributions/first-contributions). You can find first good issues (if any 🙂) [here](https://github.com/control-toolbox/OptimalControlProblems.jl/contribute). You may find other packages to contribute to at the [control-toolbox organization](https://github.com/control-toolbox). + +If you want to ask a question, feel free to start a discussion [here](https://github.com/orgs/control-toolbox/discussions). This forum is for general discussion about this repository and the [control-toolbox organization](https://github.com/control-toolbox). + +!!! note + + If you want to add an application or a package to the control-toolbox ecosystem, please follow this [set up tutorial](https://github.com/orgs/control-toolbox/discussions/65). + ## Credits (not exhaustive!) - [Nico77310](https://github.com/Nico77310)