Skip to content

Commit 449abcd

Browse files
authored
Merge pull request #362 from control-toolbox/doc
Doc
2 parents e07eae7 + adca381 commit 449abcd

File tree

3 files changed

+9
-5
lines changed

3 files changed

+9
-5
lines changed

docs/src/api-ctbase.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ You may find in this package:
2222
- [Differential geometry](@ref api-ctbase-differential-geometry): tools to compute [Lie brackets](https://en.wikipedia.org/w/index.php?title=Lie_bracket_of_vector_fields&oldid=1163591634), [Poisson brackets](https://en.wikipedia.org/w/index.php?title=Poisson_manifold&oldid=1163991099#Formal_definition)...
2323
- [Exceptions](@ref api-ctbase-exceptions).
2424
- [Initial guess](@ref api-ctbase-init): tools to define an initial guess.
25-
- [Model](@ref api-ctbase-model): tools to modelise an optimal control problem in a functional manner.
26-
- [Parser](@ref api-ctbase-parser): tools to modelise an optimal control problem in an abstract manner.
25+
- [Model](@ref api-ctbase-model): tools to model an optimal control problem in a functional manner.
26+
- [Parser](@ref api-ctbase-parser): tools to model an optimal control problem in an abstract manner.
2727
- [Print](@ref api-ctbase-print): check how an optimal control problem is displayed.
2828
- [Repl](@ref api-ctbase-repl): control-toolbox repl.
2929
- [Solution](@ref api-ctbase-solution): optimal control solution.

docs/src/index.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ and other constraints such as
4646

4747
## Basic usage
4848

49-
Let us modelise, solve and plot a simple optimal control problem.
49+
Let us model, solve and plot a simple optimal control problem.
5050

5151
```julia
5252
using OptimalControl
@@ -102,3 +102,7 @@ If it is your first contribution, you can also check [this first contribution tu
102102
You can find first good issues (if any 🙂) [here](https://github.com/control-toolbox/OptimalControl.jl/contribute). You may find other packages to contribute to at the [control-toolbox organization](https://github.com/control-toolbox).
103103

104104
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).
105+
106+
!!! note
107+
108+
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).

docs/src/tutorial-solve.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ In a direct method, the optimal control problem is transcribed to a nonlinear op
6363
\text{minimize}\quad F(y), \quad\text{subject to the constraints}\quad g(y)=0, \quad h(y)\le 0.
6464
```
6565

66-
OptimalControl.jl package makes the transcription but it needs a package to modelise the NLP problem and
66+
OptimalControl.jl package makes the transcription but it needs a package to model the NLP problem and
6767
another one to solve it. NLPModelsIpopt.jl package provides an interface to the well-known solver
6868
[Ipopt](https://coin-or.github.io/Ipopt/) that can be used to solve general nonlinear programming problems.
6969

@@ -96,7 +96,7 @@ solve(ocp, :direct, :adnlp, :ipopt)
9696
```
9797

9898
Let us detail the three symbols. As you can see, there are only direct methods. The symbol `:adnlp` is for the
99-
choice of modeler. As said before, the NLP problem needs to be modelised in Julia code. We use
99+
choice of modeler. As said before, the NLP problem needs to be modelled in Julia code. We use
100100
[ADNLPModels.jl](https://jso.dev/ADNLPModels.jl) which provides automatic differentiation (AD)-based model implementations that conform to the [NLPModels.jl](https://github.com/JuliaSmoothOptimizers/ADNLPModels.jl) API.
101101

102102
The last symbol is what distinguish the two available methods. It corresponds to the NLP solver. By default, we

0 commit comments

Comments
 (0)