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.

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

Use Asciicast.jl to display console output #673

Closed
wants to merge 5 commits into from
Closed

Use Asciicast.jl to display console output #673

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
32105a7
Use Asciicast.jl to display console outpout
efaulhaber Nov 20, 2024
a2053b1
Add compat for Asciicast.jl
efaulhaber Nov 20, 2024
a515a3f
Fix incorrect smoothing length
efaulhaber Nov 21, 2024
c5ea990
Reformat code
efaulhaber Nov 21, 2024
4cfdcd0
Merge branch 'main' into tut_setup_asciicast
efaulhaber Dec 12, 2024
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
3 changes: 3 additions & 0 deletions docs/Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
[deps]
Asciicast = "2600d445-abca-43b9-92aa-ce144ac0b05b"
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"
TrixiParticles = "66699cd8-9c01-4e9d-a059-b96c86d16b3a"

[compat]
Asciicast = "0.1.2"
Documenter = "1"
DocumenterCitations = "1"
OrdinaryDiffEq = "6"
Expand Down
3 changes: 2 additions & 1 deletion docs/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ using Documenter, DocumenterCitations
using TrixiParticles
using TrixiBase
using PointNeighbors
using Asciicast: Asciicast

# Get TrixiParticles.jl root directory
trixiparticles_root_dir = dirname(@__DIR__)
Expand Down Expand Up @@ -111,7 +112,7 @@ makedocs(sitename="TrixiParticles.jl",
plugins=[bib],
# Run doctests and check docs for the following modules
modules=[TrixiParticles],
format=Documenter.HTML(),
format=Documenter.HTML(; assets=Asciicast.assets()),
# Explicitly specify documentation structure
pages=[
"Home" => "index.md",
Expand Down
8 changes: 3 additions & 5 deletions docs/src/tutorials_template/tut_setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,9 +208,8 @@ respective simulation.
You can find both approaches in our [example files](@ref examples).
Here, we just use the method with the default parameters, and only disable
`save_everystep` to avoid expensive saving of the solution in every time step.
```@example tut_setup
```@cast tut_setup; width=100, height=50, delay=0.25
sol = solve(ode, RDPK3SpFSAL35(), save_everystep=false, callback=callbacks);
nothing # hide
```

See [Visualization](@ref) for how to visualize the final solution.
Expand Down Expand Up @@ -315,8 +314,7 @@ In order to use our kernel in a pre-defined example file, we can use the functio
The following will run the example simulation
`examples/fluid/hydrostatic_water_column_2d.jl` with our custom kernel and the corresponding
smoothing length.
```@example tut_setup
```@cast tut_setup; width=100, height=50, delay=0.1
trixi_include(joinpath(examples_dir(), "fluid", "hydrostatic_water_column_2d.jl"),
smoothing_kernel=MyGaussianKernel(), smoothing_length=smoothing_length_gauss);
nothing # hide
smoothing_kernel=MyGaussianKernel());
```
Loading