Skip to content

Commit a1b16fc

Browse files
committed
Add section "Running the examples"
1 parent 2960061 commit a1b16fc

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,33 @@ at the Julia prompt. You can run the unit tests with the command:
3535
pkg"test VortexStepMethod"
3636
```
3737

38+
## Running the examples
39+
If you have git installed, check out this repo because it makes it easier to understand the code:
40+
```bash
41+
mkdir repos
42+
cd repos
43+
git clone https://github.com/Albatross-Kite-Transport/VortexStepMethod.jl
44+
cd VortexStepMethod.jl
45+
```
46+
You can launch Julia with:
47+
```bash
48+
julia --project
49+
```
50+
or with:
51+
```bash
52+
./bin/run_julia
53+
```
54+
In Julia, first update the packages:
55+
```julia
56+
using Pkg
57+
Pkg.update()
58+
```
59+
and then you can execute the first example:
60+
```julia
61+
include("examples/rectangular_wing.jl")
62+
```
63+
To browse the code, it is suggested to use [VSCode](https://code.visualstudio.com/) with the Julia plugin.
64+
3865
## Input
3966
Three kinds of input data is needed:
4067

0 commit comments

Comments
 (0)