Skip to content

Commit cf20bda

Browse files
committed
added solve on gpu section
1 parent d521c00 commit cf20bda

4 files changed

Lines changed: 17 additions & 3 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
[downloads-total-url]: https://juliapkgstats.com/pkg/OptimalControl
3535

3636
The OptimalControl.jl package is the root package of the [control-toolbox ecosystem](https://github.com/control-toolbox).
37-
The control-toolbox ecosystem gathers Julia packages for mathematical control and applications. It aims to provide tools to model and solve optimal control problems with ordinary differential equations by direct and indirect methods.
37+
The control-toolbox ecosystem gathers Julia packages for mathematical control and applications. It 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.
3838

3939
| **Name** | **Badge** |
4040
:-------------------|:------------------|

docs/make.jl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ cp("./docs/Project.toml", "./docs/src/assets/Project.toml"; force=true)
111111
repo_url = "github.com/control-toolbox/OptimalControl.jl"
112112

113113
makedocs(;
114-
draft=false, # if draft is true, then the julia code from .md is not executed
114+
draft=true, # if draft is true, then the julia code from .md is not executed
115115
# to disable the draft mode in a specific markdown file, use the following:
116116
# ```@meta
117117
# Draft = false
@@ -138,6 +138,7 @@ makedocs(;
138138
"Problem characteristics" => "manual-model.md",
139139
"Set an initial guess" => "manual-initial-guess.md",
140140
"Solve a problem" => "manual-solve.md",
141+
"Solve on GPU" => "manual-solve-gpu.md",
141142
"Solution characteristics" => "manual-solution.md",
142143
"Plot a solution" => "manual-plot.md",
143144
"Compute flows" => [

docs/src/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# OptimalControl.jl
22

3-
The OptimalControl.jl package is the root package of the [control-toolbox ecosystem](https://github.com/control-toolbox). The control-toolbox ecosystem gathers Julia packages for mathematical control and applications. It aims to provide tools to model and solve optimal control problems with ordinary differential equations by direct and indirect methods.
3+
The OptimalControl.jl package is the root package of the [control-toolbox ecosystem](https://github.com/control-toolbox). The control-toolbox ecosystem gathers Julia packages for mathematical control and applications. It 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.
44

55
## Installation
66

docs/src/manual-solve-gpu.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# [Solve on GPU](@id manual-solve)
2+
3+
```@meta
4+
CollapsedDocStrings = false
5+
```
6+
7+
In this manual, we explain how to use the [`solve`](@ref) function from [OptimalControl.jl](https://control-toolbox.org/OptimalControl.jl) on GPU. We rely on [MadNLP](https://github.com/MadNLP/MadNLP.jl) and currently only provide support for NVIDIA thanks to [CUDA.jl](https://github.com/JuliaGPU/CUDA.jl).
8+
9+
```@docs; canonical=false
10+
solve(::CTModels.Model, ::Symbol...)
11+
```
12+
13+
TBC

0 commit comments

Comments
 (0)