Skip to content

Commit e2da611

Browse files
committed
Fix warnings
1 parent 33e952e commit e2da611

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

docs/src/index.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,26 +55,35 @@ required packages ([GLMakie](https://docs.makie.org/stable/), CSV, etc.).
5555

5656
## Running the examples as developer
5757
If you have git installed, check out this repo because it makes it easier to understand the code:
58+
5859
```bash
5960
mkdir repos
6061
cd repos
6162
git clone https://github.com/OpenSourceAWE/VortexStepMethod.jl
6263
cd VortexStepMethod.jl/bin
6364
./install
6465
```
66+
6567
You can launch Julia with:
68+
6669
```bash
6770
jl
6871
```
72+
6973
or with:
74+
7075
```bash
7176
./bin/run_julia
7277
```
78+
7379
Then you can display a menu with the available examples using the GLMakie library:
80+
7481
```julia
7582
menu()
7683
```
84+
7785
or using the ControlPlots library (faster time-to-first-plot):
86+
7887
```julia
7988
menu_cp()
8089
```
@@ -100,6 +109,7 @@ Three kinds of input data is needed:
100109
Wing geometry can also be loaded from YAML files or `.obj` files. See the examples for details.
101110

102111
### Example for defining the required input:
112+
103113
```julia
104114

105115
# Step 1: Define wing parameters
@@ -134,6 +144,7 @@ body_aero = BodyAerodynamics([wing])
134144
vel_app = [cos(alpha), 0.0, sin(alpha)] .* v_a
135145
set_va!(body_aero, vel_app)
136146
```
147+
137148
It is possible to import the wing geometry using an `.obj` file as shown in the example `ram_air_kite.jl`. During the import the polars are calculated automatically using XFoil. This approach is valid for rigid wings and ram-air kites, but not for leading edge inflatable kites.
138149

139150
Surfplan files can be converted to an input for `VortexStepMethod.jl` using the [SurfplanAdapter](https://github.com/jellepoland/SurfplanAdapter).

0 commit comments

Comments
 (0)