https://github.com/wias-pdelib/gridvisualize.jl
https://github.com/wias-pdelib/gridvisualize.jl
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/wias-pdelib/gridvisualize.jl
- Owner: WIAS-PDELib
- License: mit
- Created: 2021-01-09T18:55:42.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-09-05T02:13:34.000Z (9 months ago)
- Last Synced: 2025-09-20T22:37:32.770Z (9 months ago)
- Language: Julia
- Size: 1.41 GB
- Stars: 19
- Watchers: 4
- Forks: 7
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/WIAS-PDELib/GridVisualize.jl/actions/workflows/ci.yml?query=branch%3Amain)
[](https://WIAS-PDELib.github.io/GridVisualize.jl/stable)
[](https://WIAS-PDELib.github.io/GridVisualize.jl/dev)
[](https://github.com/fredrikekre/Runic.jl)
GridVisualize
=============
Plotting companion module for [ExtendableGrids.jl](https://github.com/WIAS-PDELib/ExtendableGrids.jl)
Provides plotting of grids, scalar piecewise linear functions and vectors (2D only) for various plotting backends
on simplicial grids in one, two or three space dimensions. The main supported backends
are CairoMakie, GLMakie, PythonPlot, PyPlot, and PlutoVista. Plots is only partially supported (1D and 2D rectangular grids).
## Disclaimer
The code is rather complex and many codepaths are hard to test. Please be prepared to help
fixing things.
## Sample usage:
### Plotting a grid, a function or a vector field
````
gridplot(grid, Plotter=GLMakie)
scalarplot(grid, function,Plotter=GLMakie)
vectorplot(grid, vectorfunction,Plotter=GLMakie)
streamplot(grid, vectorfunction,Plotter=GLMakie)
````
This works for 1/2/3D grids and either a function represented by its
values on the nodes of the grid, or a scalar function of 1, 2 or 3
variables, respectively. Vector and stream plots are currently available for 2D only.
The `grid` argument should be an `ExtendableGrid` as defined by the [ExtendableGrids.jl](https://github.com/WIAS-PDELib/ExtendableGrids.jl) package.
Instead of `grid`, the following arguments can be passed in order to describe a grid (which then is internally created on-the-fly):
- An `AbstractVector` `X` specifying an 1D grid
- `AbstractVector`s `X,Y` specifying a 2D grid
- `AbstractVector`s `X,Y,Z` specifying a 3D grid
- `coord, cellnodes`, where `coord` is a `dim x nn` matrix of point coordinates and
`cellnodes` is as `dim+1 x nc` connectivity matrix of simplex node indices, describing
a `dim`-dimensional simplex grid with `nn` nodes and `nc` simplices.
Plot appearance can be tweaked by a number of
[keyword arguments](https://WIAS-PDELib.github.io/GridVisualize.jl/dev/api/#GridVisualize.available_kwargs).
### Plotters
Plotters can be e.g. Plots, PythonPlot, PyPlot, GLMakie, CairoMakie PlutoVista - we pass the module exported
by the package. Different plotters can be used at the same time.
### Multiple plots in one plotting window
````
vis=GridVisualizer(Plotter=GLMakie, layout=(1,2))
gridplot!(vis[1,1],grid)
scalarplot!(vis[1,2],grid,function)
reveal(vis)
````
### Transient plots
This using fast updating via observables for GLMakie and persistent divs with PlutoVista.
````
vis=GridVisualizer(Plotter=GLMakie)
for i=1:N
function=calculate(i)
scalarplot!(vis,grid,function)
reveal(vis)
end
````
### Movies
Currently, these can be recorded with GLMakie, CairoMakie and Plots backends both from
the REPL and Pluto notebooks. MP4 files and gifs can be created.
PyPlot/PythonPlot possibly will follow.
This shows the animated graphic in the REPL (essentially the same as above)
and creates an embedded video in a Pluto notebook:
````
vis=GridVisualizer(Plotter=Plots)
movie(vis) do vis
for i=1:N
function=calculate(i)
scalarplot!(vis,grid,function)
reveal(vis)
end
end
````
To save to a file instead of showing in a notebooks or from the REPL , use:
````
vis=GridVisualizer(Plotter=CairoMakie)
movie(vis, file="video.mp4") do vis
for i=1:N
function=calculate(i)
scalarplot!(vis,grid,function)
reveal(vis)
end
end
````
### Setting a default plotter
Instead of specifying a `Plotter` in calls to `GridVisualizer`,
`gridplot` or `scalarplot`, a default plotter can be set:
```
default_plotter!(PyPlot)
gridplot(grid)
scalarplot(grid, function)
```
or
```
default_plotter!(GLMakie)
vis=GridVisualizer(layout=(1,2))
gridplot!(vis[1,1],grid)
scalarplot!(vis[1,2],grid,function)
```
### Switching off plotting
Just pass `Plotter=nothing` in the respective places, or set `default_plotter!(nothing)`
and all plotting functions will do nothing.
## Available plotting backends and functionality.
- 'y': available
- 'i': some level of interactive control
- '(y)': availability only on rectangular grids
- 'p': planned (no schedule though)
- 'n': probably not, also in the future
| | PyPlot/PythonPlot | Makie | PlutoVista | Plots | VTKView |
|----------------|--------------------|-------|------------|-------|---------|
| scalarplot, 1D | y | y | y,i | y | y |
| vectorplot, 1D | y | y | y | y | y |
| gridplot, 1D | y | y | y | y | |
| scalarplot, 2D | y | y | y | (y) | y,i |
| vectorplot, 2D | y | y | y | y | |
| streamplot, 2D | y | y | p | n | |
| gridplot, 2D | y | y,i | y | (y) | y,i |
| scalarplot, 3D | y | y,i | y,i | n | y,i |
| gridplot, 3D | y | y,i | y,i | n | y,i |
| vectorplot, 3D | p | p | p | n | |
| streamplot, 3D | | p | p | n | |
| movie | n | y | n | y | |
| triangulateio | y | y | n | n | n |
## Sample output
### [PyPlot](https://github.com/JuliaPy/PyPlot.jl), [PythonPlot](https://github.com/JuliaPy/PythonPlot.jl):
### [GLMakie](https://github.com/JuliaPlots/GLMakie.jl):
### [Plots/gr](https://github.com/JuliaPlots/Plots.jl):
![](https://github.com/WIAS-PDELib/GridVisualize.jl/blob/main/docs/src/assets/multiscene_plots.png?raw=true")
### [VTKView](https://github.com/j-fu/VTKView.jl) (experimental):
![](https://github.com/WIAS-PDELib/GridVisualize.jl/blob/main/docs/src/assets/multiscene_vtkview.png?raw=true")
## vscode
Plotting into the plot pane of Visual Studio Code is working. Here, you can use CairoMakie or WGLMakie as backend. This works only with the mutating functions, i.e. you should use something like
```
vis=GridVisualizer(Plotter=WGLMakie)
gridplot!(vis,grid,clear=true,show=true)
```
## Notebooks
### Pluto
Plotting in Pluto notebooks for CairoMakie, PyPlot, PythonPlot, Plots, GLMakie is working, WGLMakie probably works in combination with JSServe.
Plotting in Pluto notebooks can use [PlutoVista.jl](https://github.com/j-fu/PlutoVista.jl)
based on [plotly.js](https://plotly.com/javascript/) (1D) and [vtk.js](https://kitware.github.io/vtk-js/index.html) (2/3D).
See the example notebook: [pluto](https://raw.githubusercontent.com/WIAS-PDELib/GridVisualize.jl/main/examples/plutovista.jl),
[html](https://WIAS-PDELib.github.io/GridVisualize.jl/dev/plutovista.html).
### Jupyter
Chances are that things work with Jupyter as well. Please ping me if you would like to volunteer with testing and
possibly fixing this.