Skip to content
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.

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

[Docs] Getting started page claims a plot is automatically diplayed, but it isn't #629

Closed
giordano opened this issue Oct 21, 2024 · 3 comments · Fixed by #631
Closed

[Docs] Getting started page claims a plot is automatically diplayed, but it isn't #629

giordano opened this issue Oct 21, 2024 · 3 comments · Fixed by #631
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@giordano
Copy link
Contributor

giordano commented Oct 21, 2024

The example at https://trixi-framework.github.io/TrixiParticles.jl/v0.2.2/getting_started/#Running-an-Example claims that a plot is automatically displayed, but that's not the case, and I don't see how that'd happen, since there's nothing about plotting in the code at https://github.com/trixi-framework/TrixiParticles.jl/blob/b51cd2664b02d4dc98600dd8aeadf61a6c66e125/examples/fluid/hydrostatic_water_column_2d.jl.

Reproducer:

using Pkg
Pkg.add(["TrixiParticles", "OrdinaryDiffEq", "Plots"])
using TrixiParticles
trixi_include(joinpath(examples_dir(), "fluid", "hydrostatic_water_column_2d.jl"))
@efaulhaber
Copy link
Member

Thanks for catching this! The plot(sol) got lost somewhere.

@efaulhaber efaulhaber added bug Something isn't working documentation Improvements or additions to documentation labels Oct 21, 2024
@giordano
Copy link
Contributor Author

Note that with plots(sol) I get
image
which doesn't exactly look like the plot shown in the documentation 🙂

@LasNikas
Copy link
Collaborator

Thanks again for catching this. We'll fix it ASAP.
The bug is in the order of the parametes:

const TrixiParticlesODESolution = ODESolution{<:Any, <:Any, <:Any, <:Any, <:Any, <:Any,

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants