|
1 | 1 | # SIRcontrol.jl |
2 | 2 |
|
3 | | -[ci-img]: https://github.com/AnasXbouali/SIRcontrol.jl/actions/workflows/CI.yml/badge.svg?branch=main |
4 | | -[ci-url]: https://github.com/AnasXbouali/SIRcontrol.jl/actions/workflows/CI.yml?query=branch%3Amain |
| 3 | +<!-- |
| 4 | +For instructions on how to customize this README.template.md and use the centralized workflow, |
| 5 | +please see the user guide: https://github.com/orgs/control-toolbox/discussions/67 |
| 6 | +--> |
5 | 7 |
|
6 | | -[doc-dev-img]: https://img.shields.io/badge/docs-dev-8A2BE2.svg |
7 | | -[doc-dev-url]: https://AnasXbouali.github.io/SIRcontrol.jl/dev/ |
| 8 | +The SIRcontrol.jl repo is part of the [control-toolbox ecosystem](https://github.com/control-toolbox). |
8 | 9 |
|
9 | | -[doc-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg |
10 | | -[doc-stable-url]: https://AnasXbouali.github.io/SIRcontrol.jl/stable/ |
| 10 | +| **Category** | **Badge** | |
| 11 | +|-----------------------|-----------| |
| 12 | +| **Documentation** | [](https://control-toolbox.org/SIRcontrol.jl/stable/) [](https://control-toolbox.org/SIRcontrol.jl/dev/) | |
| 13 | +| **CI / Build** | [](https://github.com/control-toolbox/SIRcontrol.jl/actions/workflows/CI.yml?query=branch%3Amain) | |
| 14 | +| **Test Coverage** | [](https://codecov.io/gh/control-toolbox/SIRcontrol.jl) | |
| 15 | +| **Release / Version** | [](https://github.com/control-toolbox/SIRcontrol.jl/releases) | |
| 16 | +| **License** | [](https://github.com/control-toolbox/SIRcontrol.jl/blob/master/LICENSE) | |
| 17 | +| **Code Style / Quality** | [](https://github.com/JuliaDiff/BlueStyle) [](https://github.com/JuliaTesting/Aqua.jl) | |
11 | 18 |
|
12 | | -[licence-img]: https://img.shields.io/badge/License-MIT-yellow.svg |
13 | | -[licence-url]: https://github.com/AnasXbouali/SIRcontrol.jl/blob/master/LICENSE |
| 19 | +## About control-toolbox |
14 | 20 |
|
15 | | -[aqua-img]: https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg |
16 | | -[aqua-url]: https://github.com/JuliaTesting/Aqua.jl |
| 21 | +The **control-toolbox** ecosystem brings together <a href="https://julialang.org" style="display:inline-flex; align-items:center;"> |
| 22 | + <img src="https://raw.githubusercontent.com/JuliaLang/julia-logo-graphics/master/images/julia.ico" width="16em" style="margin-right:0.3em;"> |
| 23 | + Julia |
| 24 | +</a> packages for mathematical control and its applications. |
17 | 25 |
|
18 | | -[blue-img]: https://img.shields.io/badge/code%20style-blue-4495d1.svg |
19 | | -[blue-url]: https://github.com/JuliaDiff/BlueStyle |
| 26 | +- The root package, [OptimalControl.jl](https://github.com/control-toolbox/OptimalControl.jl), provides tools to model and solve optimal control problems defined by ordinary differential equations. It supports both direct and indirect methods, and can run on CPU or GPU. |
20 | 27 |
|
21 | | -This repo is part of the [control-toolbox ecosystem](https://github.com/control-toolbox). |
22 | | -The control-toolbox ecosystem gathers Julia packages for mathematical control and applications. The root package is [OptimalControl.jl](https://github.com/control-toolbox/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. |
| 28 | +<p align="right"> |
| 29 | + <a href="http://control-toolbox.org/OptimalControl.jl"> |
| 30 | + <img src="https://img.shields.io/badge/Documentation-OptimalControl.jl-blue" alt="Documentation OptimalControl.jl"> |
| 31 | + </a> |
| 32 | +</p> |
23 | 33 |
|
24 | | -[](http://control-toolbox.org/OptimalControl.jl) |
| 34 | +- Complementing it, [OptimalControlProblems.jl](https://github.com/control-toolbox/OptimalControlProblems.jl) offers a curated collection of benchmark optimal control problems formulated with ODEs in Julia. Each problem is available both in the **OptimalControl** DSL and in **JuMP**, with discretised versions ready to be solved using the solver of your choice. This makes the package particularly useful for benchmarking and comparing different solution strategies. |
25 | 35 |
|
26 | | -| **Name** | **Badge** | |
27 | | -:-------------------|:------------------| |
28 | | -| Documentation | [![Documentation][doc-stable-img]][doc-stable-url] [![Documentation][doc-dev-img]][doc-dev-url] | |
29 | | -| Code Status | [![Build Status][ci-img]][ci-url] [![Aqua.jl][aqua-img]][aqua-url] [![Code Style: Blue][blue-img]][blue-url] | |
30 | | -| Licence | [![License: MIT][licence-img]][licence-url] | |
| 36 | +<p align="right"> |
| 37 | + <a href="http://control-toolbox.org/OptimalControlProblems.jl"> |
| 38 | + <img src="https://img.shields.io/badge/Documentation-OptimalControlProblems.jl-blue" alt="Documentation OptimalControlProblems.jl"> |
| 39 | + </a> |
| 40 | +</p> |
31 | 41 |
|
32 | 42 | ## Contributing |
33 | 43 |
|
34 | | -[issue-url]: https://github.com/control-toolbox/CTApp.jl/issues |
35 | | -[first-good-issue-url]: https://github.com/control-toolbox/CTApp.jl/contribute |
| 44 | +[issue-url]: https://github.com/control-toolbox/SIRcontrol.jl/issues |
| 45 | +[first-good-issue-url]: https://github.com/control-toolbox/SIRcontrol.jl/contribute |
36 | 46 |
|
37 | | -If you think you found a bug or if you have a feature request / suggestion, feel free to open an [issue][issue-url]. |
| 47 | +If you think you found a bug or if you have a feature request / suggestion, feel free to open an [issue][issue-url]. |
38 | 48 | Before opening a pull request, please start an issue or a discussion on the topic. |
39 | 49 |
|
40 | | -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). |
41 | | -If it is your first contribution, you can also check [this first contribution tutorial](https://github.com/firstcontributions/first-contributions). |
42 | | -You can find first good issues (if any 🙂) [here][first-good-issue-url]. You may find other packages to contribute to at the [control-toolbox organization](https://github.com/control-toolbox). |
| 50 | +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][first-good-issue-url]. You may find other packages to contribute to at the [control-toolbox organization](https://github.com/control-toolbox). |
43 | 51 |
|
44 | 52 | 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). |
45 | 53 |
|
46 | 54 | >[!NOTE] |
47 | | -> If you want to add an application or a package to the control-toolbox ecosystem, please follow this [set up tutorial](https://github.com/control-toolbox/CTApp.jl/discussions/9). |
| 55 | +> 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). |
0 commit comments