Skip to content

Commit 11be4ee

Browse files
committed
Add section Contributing.
1 parent dd32e2e commit 11be4ee

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

docs/src/tips_and_tricks.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
## Tips and tricks
1+
# Tips and tricks
22

3-
### What can this model simulate
3+
## What can this model simulate
44
The following bodies can be simulated:
55

66
- conventional bodies, consisting of one or more wings
@@ -10,18 +10,21 @@ The following bodies can be simulated:
1010
To build the geometry of a RAM-air kite, a 3D .obj file can be used as input. In addition a `.dat` file is needed.
1111
It should have two columns, one for the `x` and one for the `y` coordinate of the 2D polar that is used.
1212

13-
### RAM-air kite model
13+
## RAM-air kite model
1414
If running the example `ram_air_kite.jl` fails, try to run the `cleanup.jl` script and then try again. Background: this example caches the calculated polars. Reading cached polars can fail after an update.
1515

16-
### Output formats
16+
## Output formats
1717
Currently, the `solve!()` function returns the results as [VSMSolution](@ref) struct. The function solve() returns a dictionary with the results. The `solve!()` function is faster, and the `solve()` contains many more entries, therefore the first function is good for integration in dynamic models and the second one better suited for aerodynamic analysis.
1818

19-
### Performance
19+
## Performance
2020
Calling `init!(body_aero; init_aero=false)` is very fast. After calling `deform!(wing)`, you have to run `init!(body_aero; init_aero=false)` to apply the deformed wing to the body aerodynamics. This is in turn necessary for the linearization from deformation to aerodynamic coefficients for RAM-air kites.
2121

22-
### Building the documentation locally
22+
## Contributing
23+
Please, read [CONTRIBUTING.md](https://github.com/Albatross-Kite-Transport/VortexStepMethod.jl/blob/main/CONTRIBUTING.md)
24+
25+
## Building the documentation locally
2326
You can build the documentation locally after checking out the source code with git, launching Julia and executing:
24-
```
27+
```julia
2528
include("scripts/build_docu.jl")
2629
```
2730
A browser window should pop up automatically.

0 commit comments

Comments
 (0)