Skip to content

DOC: Make the user guide's examples converge as printed #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thclark merged 1 commit into from
Oct 30, 2026
Merged

DOC: Make the user guide's examples converge as printed #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/user-guide/commands/analyse-a-single-point.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ yfoil analyse <GEOMETRY.json> [OPTIONS]
## Fixed angle of attack

``` sh
yfoil analyse naca0012.json --alpha 5 --reynolds 1e6 --ncrit 9 -o a5.json
yfoil analyse naca0012.json --alpha 4 --reynolds 1e6 --ncrit 9 -o a4.json
```

## Fixed lift coefficient
Expand All @@ -25,7 +25,7 @@ yfoil analyse naca0012.json --cl 0.6 --reynolds 1e6 -o cl06.json
## Inviscid

``` sh
yfoil analyse naca0012.json --alpha 5 --inviscid
yfoil analyse naca0012.json --alpha 4 --inviscid
```

## Options
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/commands/geometry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ the references are in [aerofoil series](../reference/aerofoil-series.md).

``` sh
yfoil geometry naca 0012 -n 160 -o naca0012.json
yfoil geometry naca 4412 -n 200 --sharp -o naca4412.json
yfoil geometry naca 4412 -n 160 -o naca4412.json
yfoil geometry naca 23018 -o naca23018.json
yfoil geometry naca 0012-34 -o naca0012-34.json
yfoil geometry naca 16-212 -o naca16-212.json
Expand Down
1 change: 1 addition & 0 deletions docs/user-guide/commands/polars.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ yfoil polar <GEOMETRY.json> [OPTIONS]
```

``` sh
yfoil geometry naca 4412 -n 160 -o naca4412.json
yfoil polar naca4412.json \
--alpha-min -5 --alpha-max 15 --alpha-step 0.5 \
--reynolds 1e6 --max-iterations 20 \
Expand Down
Binary file renamed docs/user-guide/figures/naca0012_a5.fig → docs/user-guide/figures/naca0012_a4.fig
View file
Open in desktop
Binary file not shown.
8 changes: 4 additions & 4 deletions docs/user-guide/get-started/your-first-analysis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ the upper surface, round the leading edge, and back along the lower surface.
## 2. Solve one operating point

``` sh
yfoil analyse naca0012.json --alpha 5 --reynolds 1e9 -o naca0012_a5.json
yfoil analyse naca0012.json --alpha 4 --reynolds 1e6 -o naca0012_a4.json
```

The output JSON carries the operating conditions, the integrated forces, the
Expand All @@ -40,8 +40,8 @@ initialised from the previous one, exactly as XFOIL does it.

``` sh
yfoil plot polar naca0012_polar.json -o naca0012_polar.fig
yfoil plot analysis naca0012_a5.json -o naca0012_a5.fig
ironlab-viewer naca0012_polar.fig naca0012_a5.fig
yfoil plot analysis naca0012_a4.json -o naca0012_a4.fig
ironlab-viewer naca0012_polar.fig naca0012_a4.fig
```

The figures open in the [ironlab viewer](../commands/plotting.md#viewing-and-exporting), which exports
Expand All @@ -50,7 +50,7 @@ to visualise them, this analysis should produce the polar and distributions belo

<ironlab-figure src="../figures/naca0012_polar.fig" format="fig" name="naca0012_polar" alt="NACA 0012 polar at Re 1e6, alpha -5 to 15 degrees">NACA 0012 polar at Re 1e6, alpha -5 to 15 degrees</ironlab-figure>

<ironlab-figure src="../figures/naca0012_a5.fig" format="fig" name="naca0012_a5" alt="NACA 0012 at alpha 5 degrees, Re 1e9: -Cp and Ue over x/c, upper and lower surfaces, above the aerofoil outline">NACA 0012 at alpha 5 degrees, Re 1e9: -Cp and Ue over x/c, upper and lower surfaces, above the aerofoil outline</ironlab-figure>
<ironlab-figure src="../figures/naca0012_a4.fig" format="fig" name="naca0012_a4" alt="NACA 0012 at alpha 4 degrees, Re 1e6: -Cp and Ue over x/c, upper and lower surfaces, above the aerofoil outline">NACA 0012 at alpha 4 degrees, Re 1e6: -Cp and Ue over x/c, upper and lower surfaces, above the aerofoil outline</ironlab-figure>

## Next

Expand Down
6 changes: 3 additions & 3 deletions scripts/guide-figures.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@ cd "$work"

# Your first analysis (get-started/your-first-analysis.md)
"$yfoil" geometry naca 0012 -n 160 -o naca0012.json
"$yfoil" analyse naca0012.json --alpha 5 --reynolds 1e9 -o naca0012_a5.json
"$yfoil" analyse naca0012.json --alpha 4 --reynolds 1e6 -o naca0012_a4.json
"$yfoil" polar naca0012.json \
--alpha-min -5 --alpha-max 15 --alpha-step 0.5 \
--reynolds 1e6 --label "NACA 0012" -o naca0012_polar.json
"$yfoil" plot polar naca0012_polar.json -o naca0012_polar.fig
"$yfoil" plot analysis naca0012_a5.json -o naca0012_a5.fig
"$yfoil" plot analysis naca0012_a4.json -o naca0012_a4.fig

# Polars (commands/polars.md)
"$yfoil" geometry naca 4412 -n 160 -o naca4412.json
Expand Down Expand Up @@ -57,6 +57,6 @@ done
--title "NACA 0012 vs 4412" -o intro.fig

rm -f "$repo_root/$out"/*.fig
cp intro.fig naca0012_polar.fig naca0012_a5.fig naca4412_polar.fig compare.fig a5.fig naca4412_foil.fig foil.fig \
cp intro.fig naca0012_polar.fig naca0012_a4.fig naca4412_polar.fig compare.fig a5.fig naca4412_foil.fig foil.fig \
"$repo_root/$out/"
echo "wrote $(ls "$repo_root/$out"/*.fig | wc -l | tr -d ' ') figures to $out"
Loading