Skip to content

Commit 9922006

Browse files
committed
add section Installation to README
1 parent b24f5f3 commit 9922006

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,28 @@ The software presented here includes a couple of examples: a rectangular wing an
88

99
This package was translated from the Python code available at https://github.com/awegroup/Vortex-Step-Method .
1010

11+
## Installation
12+
Install [Julia 1.10](https://ufechner7.github.io/2024/08/09/installing-julia-with-juliaup.html) or later, if you haven't already. On Linux, make sure that Python3 and Matplotlib are installed:
13+
```
14+
sudo apt install python3-matplotlib
15+
```
16+
17+
Before installing this software it is suggested to create a new project, for example like this:
18+
```bash
19+
mkdir test
20+
cd test
21+
julia --project=.
22+
```
23+
Then add VortexStepMethod from Julia's package manager, by typing:
24+
```julia
25+
using Pkg
26+
pkg"add VortexStepMethod"
27+
```
28+
at the Julia prompt. You can run the unit tests with the command:
29+
```julia
30+
pkg"test VortexStepMethod"
31+
```
32+
1133
## Input
1234
- geometry, defined by section
1335
- rec wing two section, two point + polars

0 commit comments

Comments
 (0)