From cbcac9c715786778da90b7626e4bef4533d7e2c8 Mon Sep 17 00:00:00 2001 From: Erik Faulhaber <44124897+efaulhaber@users.noreply.github.com> Date: Tue, 22 Oct 2024 10:35:35 +0200 Subject: [PATCH] Fix getting started docs (#631) --- docs/Project.toml | 1 + docs/src/getting_started.md | 5 +++++ 2 files changed, 6 insertions(+) diff --git a/docs/Project.toml b/docs/Project.toml index 724652ce4..8d492d46b 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -2,6 +2,7 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" DocumenterCitations = "daee34ce-89f3-4625-b898-19384cb65244" OrdinaryDiffEq = "1dea7af3-3e70-54e6-95c3-0bf5283fa5ed" +Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80" PointNeighbors = "1c4d5385-0a27-49de-8e2c-43b175c8985c" TrixiBase = "9a0f1c46-06d5-4909-a5a3-ce25d3fa3284" diff --git a/docs/src/getting_started.md b/docs/src/getting_started.md index 3c71aa83b..a68bb620c 100644 --- a/docs/src/getting_started.md +++ b/docs/src/getting_started.md @@ -18,6 +18,11 @@ Then start the simulation by executing julia> trixi_include(joinpath(examples_dir(), "fluid", "hydrostatic_water_column_2d.jl")) ``` +The easiest way to quickly visualize the result is to use Plots.jl: +```jldoctest getting_started; filter = r".*"s, setup=:(trixi_include(@__MODULE__, joinpath(examples_dir(), "fluid", "hydrostatic_water_column_2d.jl"))) +julia> using Plots; plot(sol) +``` + This will open a new window with a 2D visualization of the final solution: ![plot_hydrostatic_water_column](https://github.com/trixi-framework/TrixiParticles.jl/assets/44124897/95821154-577d-4323-ba57-16ef02ea24e0)