Skip to content

Commit cbcac9c

Browse files
authored
Fix getting started docs (trixi-framework#631)
1 parent b51cd26 commit cbcac9c

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

docs/Project.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
33
DocumenterCitations = "daee34ce-89f3-4625-b898-19384cb65244"
44
OrdinaryDiffEq = "1dea7af3-3e70-54e6-95c3-0bf5283fa5ed"
5+
Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
56
PointNeighbors = "1c4d5385-0a27-49de-8e2c-43b175c8985c"
67
TrixiBase = "9a0f1c46-06d5-4909-a5a3-ce25d3fa3284"
78

docs/src/getting_started.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,11 @@ Then start the simulation by executing
1818
julia> trixi_include(joinpath(examples_dir(), "fluid", "hydrostatic_water_column_2d.jl"))
1919
```
2020

21+
The easiest way to quickly visualize the result is to use Plots.jl:
22+
```jldoctest getting_started; filter = r".*"s, setup=:(trixi_include(@__MODULE__, joinpath(examples_dir(), "fluid", "hydrostatic_water_column_2d.jl")))
23+
julia> using Plots; plot(sol)
24+
```
25+
2126
This will open a new window with a 2D visualization of the final solution:
2227
![plot_hydrostatic_water_column](https://github.com/trixi-framework/TrixiParticles.jl/assets/44124897/95821154-577d-4323-ba57-16ef02ea24e0)
2328

0 commit comments

Comments
 (0)