control-toolbox · ocots · Nov 8, 2025 · Jul 11, 2025 · Jul 11, 2025 · Jul 11, 2025
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -1,24 +1,15 @@
-# [.github/workflows/CI.yml]
 name: CI
+
 on:
   push:
     branches:
       - main
     tags: '*'
   pull_request:
+
 jobs:
   call:
-    strategy:
-      matrix:
-        version:
-          - '1.10'
-          - '1.11'
-        os:
-          - ubuntu-latest
-        arch:
-          - x64
     uses: control-toolbox/CTActions/.github/workflows/ci.yml@main
     with:
-      version: ${{ matrix.version }}
-      os: ${{ matrix.os }}
-      arch: ${{ matrix.arch }}
+      runners: '["ubuntu-latest"]'
+      versions: '["1.12"]'
diff --git a/.github/workflows/SpellCheck.yml b/.github/workflows/SpellCheck.yml
@@ -0,0 +1,9 @@
+name: Spell Check
+
+on:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  call:
+    uses: control-toolbox/CTActions/.github/workflows/spell-check.yml@main
diff --git a/.github/workflows/UpdateReadme.yml b/.github/workflows/UpdateReadme.yml
@@ -0,0 +1,39 @@
+name: Update README with ABOUT.md and INSTALL.md
+
+on:
+  schedule:
+    - cron: '0 6 * * 1'   # every Monday at 06:00 UTC
+  workflow_dispatch:       # manual trigger
+
+jobs:
+  check-template:
+    runs-on: ubuntu-latest
+    outputs:
+      has_template: ${{ steps.check.outputs.has_template }}
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v5
+
+      - name: Check for README.template.md
+        id: check
+        shell: bash
+        run: |
+          if [[ -f "README.template.md" ]]; then
+            echo "has_template=true" >> "$GITHUB_OUTPUT"
+          else
+            echo "has_template=false" >> "$GITHUB_OUTPUT"
+            echo "README.template.md not found. Skipping README update." >&2
+          fi
+
+  call-shared:
+    needs: check-template
+    if: ${{ needs.check-template.outputs.has_template == 'true' }}
+    uses: control-toolbox/CTActions/.github/workflows/update-readme.yml@main
+    with:
+      template_file: README.template.md
+      output_file: README.md
+      package_name: Tutorials        # package for INSTALL.md
+      repo_name: control-toolbox/Tutorials.jl            # repository for CONTRIBUTING.md links
+      doc_url: https://control-toolbox.org/Tutorials.jl
+      assignee: "ocots"
+    secrets: inherit
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,14 @@
+## Contributing
+
+[issue-url]: https://github.com/control-toolbox/Tutorials.jl/issues
+[first-good-issue-url]: https://github.com/control-toolbox/Tutorials.jl/contribute
+
+If you think you found a bug or if you have a feature request / suggestion, feel free to open an [issue][issue-url].  
+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][first-good-issue-url]. 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).
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "Tutorials"
 uuid = "cb10daa6-a5e5-4c25-a171-ae181b8ea3c9"
 authors = ["Olivier Cots <olivier.cots@toulouse-inp.fr>"]
-version = "0.1.4"
+version = "0.3.2"
 
 [compat]
 julia = "1.10"
diff --git a/README.md b/README.md
@@ -1,48 +1,53 @@
 # Tutorials.jl
 
-[ci-img]: https://github.com/control-toolbox/Tutorials.jl/actions/workflows/CI.yml/badge.svg?branch=main
-[ci-url]: https://github.com/control-toolbox/Tutorials.jl/actions/workflows/CI.yml?query=branch%3Amain
+<!-- 
+For instructions on how to customize this README.template.md and use the centralized workflow,
+please see the user guide: https://github.com/orgs/control-toolbox/discussions/67
+-->
 
-[co-img]: https://codecov.io/gh/control-toolbox/Tutorials.jl/branch/main/graph/badge.svg?token=YM5YQQUSO3
-[co-url]: https://codecov.io/gh/control-toolbox/Tutorials.jl
+The Tutorials.jl repo is part of the [control-toolbox ecosystem](https://github.com/control-toolbox).
 
-[doc-dev-img]: https://img.shields.io/badge/docs-dev-8A2BE2.svg
-[doc-dev-url]: https://control-toolbox.org/Tutorials.jl/dev/
+| **Category** | **Badge** |
+|-----------------------|-----------|
+| **Documentation** | [![Stable Docs](https://img.shields.io/badge/docs-stable-blue.svg)](https://control-toolbox.org/Tutorials.jl/stable/) [![Dev Docs](https://img.shields.io/badge/docs-dev-8A2BE2.svg)](https://control-toolbox.org/Tutorials.jl/dev/) |
+| **CI / Build** | [![Build Status](https://github.com/control-toolbox/Tutorials.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/control-toolbox/Tutorials.jl/actions/workflows/CI.yml?query=branch%3Amain) |
+| **Test Coverage** | [![Coverage](https://codecov.io/gh/control-toolbox/Tutorials.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/control-toolbox/Tutorials.jl) |
+| **Release / Version** | [![Release](https://img.shields.io/github/v/release/control-toolbox/Tutorials.jl.svg)](https://github.com/control-toolbox/Tutorials.jl/releases) |
+| **License** | [![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/control-toolbox/Tutorials.jl/blob/master/LICENSE) |
+| **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) |
 
-[doc-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
-[doc-stable-url]: https://control-toolbox.org/Tutorials.jl/stable/
+## About control-toolbox
 
-[licence-img]: https://img.shields.io/badge/License-MIT-yellow.svg
-[licence-url]: https://github.com/control-toolbox/Tutorials.jl/blob/master/LICENSE
+The **control-toolbox** ecosystem brings together <a href="https://julialang.org" style="display:inline-flex; align-items:center;">
+  <img src="https://raw.githubusercontent.com/JuliaLang/julia-logo-graphics/master/images/julia.ico" width="16em" style="margin-right:0.3em;">
+  Julia
+</a> packages for mathematical control and its applications.  
 
-[aqua-img]: https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg
-[aqua-url]: https://github.com/JuliaTesting/Aqua.jl
+- 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.  
 
-[blue-img]: https://img.shields.io/badge/code%20style-blue-4495d1.svg
-[blue-url]: https://github.com/JuliaDiff/BlueStyle
+<p align="right">
+  <a href="http://control-toolbox.org/OptimalControl.jl">
+    <img src="https://img.shields.io/badge/Documentation-OptimalControl.jl-blue" alt="Documentation OptimalControl.jl">
+  </a>
+</p>
 
-This repo is part of the [control-toolbox ecosystem](https://github.com/control-toolbox).
-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.
+- 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.  
 
-[![doc OptimalControl.jl](https://img.shields.io/badge/Documentation-OptimalControl.jl-blue)](http://control-toolbox.org/OptimalControl.jl)
-
-| **Name**          | **Badge**         |
-:-------------------|:------------------|
-| Documentation     | [![Documentation][doc-stable-img]][doc-stable-url] [![Documentation][doc-dev-img]][doc-dev-url]                   | 
-| Code Status       | [![Build Status][ci-img]][ci-url] [![Covering Status][co-img]][co-url] [![Aqua.jl][aqua-img]][aqua-url] [![Code Style: Blue][blue-img]][blue-url] |
-| Licence           | [![License: MIT][licence-img]][licence-url]   |
+<p align="right">
+  <a href="http://control-toolbox.org/OptimalControlProblems.jl">
+    <img src="https://img.shields.io/badge/Documentation-OptimalControlProblems.jl-blue" alt="Documentation OptimalControlProblems.jl">
+  </a>
+</p>
 
 ## Contributing
 
 [issue-url]: https://github.com/control-toolbox/Tutorials.jl/issues
 [first-good-issue-url]: https://github.com/control-toolbox/Tutorials.jl/contribute
 
-If you think you found a bug or if you have a feature request / suggestion, feel free to open an [issue][issue-url].
+If you think you found a bug or if you have a feature request / suggestion, feel free to open an [issue][issue-url].  
 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][first-good-issue-url]. You may find other packages to contribute to at the [control-toolbox organization](https://github.com/control-toolbox).
+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).
 
 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).
 

diff --git a/README.template.md b/README.template.md
@@ -0,0 +1,14 @@
+# Tutorials.jl
+
+<!-- 
+For instructions on how to customize this README.template.md and use the centralized workflow,
+please see the user guide: https://github.com/orgs/control-toolbox/discussions/67
+-->
+
+The Tutorials.jl repo is part of the [control-toolbox ecosystem](https://github.com/control-toolbox).
+
+<!-- INCLUDE_BADGES: Documentation, CI, Coverage, Release, License, CodeStyle -->
+
+<!-- INCLUDE_ABOUT -->
+
+<!-- INCLUDE_CONTRIBUTING -->
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -3,6 +3,7 @@ BenchmarkTools = "6e4b80f9-dd63-53aa-95a3-0cdb28fa8baf"
 DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
 DifferentiationInterface = "a0c0ee7d-e4b9-4e03-894e-1c5f64a51d63"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+DocumenterInterLinks = "d12716ef-a0f6-4df4-a9f1-a5a34e75c656"
 ForwardDiff = "f6369f11-7733-5829-9624-2563aa707210"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 MINPACK = "4854310b-de5a-5eb6-a2a5-c1dee2bd17f9"
@@ -15,22 +16,24 @@ OrdinaryDiffEq = "1dea7af3-3e70-54e6-95c3-0bf5283fa5ed"
 Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
 Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
 Suppressor = "fd094767-a336-5f1f-9728-57cf17d0bbfb"
+Tutorials = "cb10daa6-a5e5-4c25-a171-ae181b8ea3c9"
 
 [compat]
-BenchmarkTools = "1.6"
-DataFrames = "1.7"
+BenchmarkTools = "1"
+DataFrames = "1"
 DifferentiationInterface = "0.7"
-Documenter = "1.8"
+Documenter = "1"
+DocumenterInterLinks = "1"
 ForwardDiff = "0.10, 1"
 LinearAlgebra = "1"
-MINPACK = "1.3"
+MINPACK = "1"
 MadNLP = "0.8"
 NLPModels = "0.21"
-NLPModelsIpopt = "0.10"
-NonlinearSolve = "4.6"
-OptimalControl = "1.0"
-OrdinaryDiffEq = "6.93"
-Plots = "1.40"
+NLPModelsIpopt = "0.11"
+NonlinearSolve = "4"
+OptimalControl = "1"
+OrdinaryDiffEq = "6"
+Plots = "1"
 Printf = "1"
 Suppressor = "0.2"
 julia = "1.10"
diff --git a/docs/extras/disc.jl b/docs/extras/disc.jl