Skip to content

Commit db89f01

Browse files
authored
Update README.md
1 parent 0107b04 commit db89f01

File tree

1 file changed

+0
-69
lines changed

1 file changed

+0
-69
lines changed

README.md

Lines changed: 0 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1 @@
1-
# CTBase.jl
21

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-
-->
7-
8-
The CTBase.jl package is part of the [control-toolbox ecosystem](https://github.com/control-toolbox).
9-
10-
| **Category** | **Badge** |
11-
|-----------------------|-----------|
12-
| **Documentation** | [![Stable Docs](https://img.shields.io/badge/docs-stable-blue.svg)](https://control-toolbox.org/CTBase.jl/stable/) [![Dev Docs](https://img.shields.io/badge/docs-dev-8A2BE2.svg)](https://control-toolbox.org/CTBase.jl/dev/) |
13-
| **CI / Build** | [![Build Status](https://github.com/control-toolbox/CTBase.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/control-toolbox/CTBase.jl/actions/workflows/CI.yml?query=branch%3Amain) |
14-
| **Test Coverage** | [![Coverage](https://codecov.io/gh/control-toolbox/CTBase.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/control-toolbox/CTBase.jl) |
15-
| **Package Evaluation** | [![PkgEval](https://img.shields.io/badge/Julia-package-purple)](https://juliahub.com/ui/Packages/General/CTBase) [![Dependencies](https://juliahub.com/docs/General/CTBase/stable/deps.svg)](https://juliahub.com/ui/Packages/General/CTBase?t=2) |
16-
| **Release / Version** | [![Release](https://juliahub.com/docs/General/CTBase/stable/version.svg)](https://github.com/control-toolbox/CTBase.jl/releases) |
17-
| **License** | [![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/control-toolbox/CTBase.jl/blob/master/LICENSE) |
18-
| **Code Style / Quality** | [![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/JuliaDiff/BlueStyle) [![Aqua.jl](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl) |
19-
20-
## About control-toolbox
21-
22-
The **control-toolbox** ecosystem brings together <a href="https://julialang.org" style="display:inline-flex; align-items:center;">
23-
<img src="https://raw.githubusercontent.com/JuliaLang/julia-logo-graphics/master/images/julia.ico" width="16em" style="margin-right:0.3em;">
24-
Julia
25-
</a> packages for mathematical control and its applications.
26-
27-
- 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.
28-
29-
<p align="right">
30-
<a href="http://control-toolbox.org/OptimalControl.jl">
31-
<img src="https://img.shields.io/badge/Documentation-OptimalControl.jl-blue" alt="Documentation OptimalControl.jl">
32-
</a>
33-
</p>
34-
35-
- 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.
36-
37-
<p align="right">
38-
<a href="http://control-toolbox.org/OptimalControlProblems.jl">
39-
<img src="https://img.shields.io/badge/Documentation-OptimalControlProblems.jl-blue" alt="Documentation OptimalControlProblems.jl">
40-
</a>
41-
</p>
42-
43-
## Installation
44-
45-
To install CTBase please
46-
<a href="https://docs.julialang.org/en/v1/manual/getting-started/">open Julia's interactive session (known as REPL)</a>
47-
and press <kbd>]</kbd> key in the REPL to use the package mode, then add the package:
48-
49-
```julia
50-
julia> ]
51-
pkg> add CTBase
52-
```
53-
54-
> [!TIP]
55-
> If you are new to Julia, please follow this [guidelines](https://github.com/orgs/control-toolbox/discussions/64).
56-
57-
## Contributing
58-
59-
[issue-url]: https://github.com/control-toolbox/CTBase.jl/issues
60-
[first-good-issue-url]: https://github.com/control-toolbox/CTBase.jl/contribute
61-
62-
If you think you found a bug or if you have a feature request / suggestion, feel free to open an [issue][issue-url].
63-
Before opening a pull request, please start an issue or a discussion on the topic.
64-
65-
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).
66-
67-
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).
68-
69-
>[!NOTE]
70-
> 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

Comments
 (0)