Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
j-fu committed Sep 17, 2021
1 parent 617a642 commit 7bccddc
Showing 1 changed file with 9 additions and 11 deletions.
20 changes: 9 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,19 +65,17 @@ and all plotting functions will do nothing. This also is the default.

## Available plotting backends and functionality.

The main supported backends are GLMakie and PyPlot.

- 'i' means some level of interactive control
- '(y)' means avaiability only on rectangular resp. cuboid grids.

| | PyPlot | GLMakie | Plots | VTKView | PlutoVista |
|------------|--------|---------|-------|---------|------------|
| scalar, 1D | y | y | y | y | y,i |
| grid, 1D | y | y | y | n | n |
| scalar, 2D | y | y,i | (y) | y,i | y |
| grid, 2D | y | y,i | (y) | y,i | n |
| scalar, 3D | y | y,i | no | y,i | n |
| grid, 3D | y | y,i | no | y,i | n |
| | PyPlot | GLMakie | PlutoVista | Plots | VTKView |
|------------|--------|---------|------------|-------|---------|
| scalar, 1D | y | y | y,i | y | y |
| grid, 1D | y | y | y | y | n |
| scalar, 2D | y | y,i | y | (y) | y,i |
| grid, 2D | y | y,i | y | (y) | y,i |
| scalar, 3D | y | y,i | y,i | no | y,i |
| grid, 3D | y | y,i | y,i | no | y,i |


For 2D plots, CairoMakie works as well.
Expand All @@ -104,5 +102,5 @@ Plotting within Pluto notebooks for PyPlot, Plots, GLMakie is working.

Plotting in Pluto notebooks using [PlutoVista.jl](https://github.com/j-fu/PlutoVista.jl) is under
development - see the example notebook: [pluto](https://raw.githubusercontent.com/j-fu/GridVisualize.jl/main/examples/plutovista.jl),
[html](https://j-fu.github.io/GridVisualize.jl/dev/plutovista.html)
[html](https://j-fu.github.io/GridVisualize.jl/dev/plutovista.html).

2 comments on commit 7bccddc

@j-fu
Copy link
Member Author

@j-fu j-fu commented on 7bccddc Sep 17, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/45101

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.2.21 -m "<description of version>" 7bccddc9abb0d97a3622c8c8461a20e656d667fd
git push origin v0.2.21

Please sign in to comment.