Skip to content

Commit 67b61b1

Browse files
committed
fix vtkview uuid
add MeshCat + VTKView to docs environmenr
1 parent 471faf8 commit 67b61b1

File tree

5 files changed

+28
-26
lines changed

5 files changed

+28
-26
lines changed

Project.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ MeshCat = "283c5d60-a78f-5afe-a0af-af636b173e11"
2626
Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
2727
PlutoVista = "646e1f28-b900-46d7-9d87-d554eb38a413"
2828
PyPlot = "d330b81b-6aea-500a-939a-2ce795aea3ee"
29-
VTKView = "63b67fce-66f7-11ea-1808-1361d8c55bf4"
29+
VTKView = "955f2c64-5fd0-11e9-0ad0-3332e913311a"
3030

3131
[extensions]
3232
GridVisualizeMakieExt = "Makie"

README.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -131,21 +131,21 @@ and all plotting functions will do nothing.
131131
- 'p': planned (no schedule though)
132132
- 'n': probably not, also in the future
133133

134-
| | PyPlot | Makie | PlutoVista | Plots | VTKView |
135-
|----------------|--------|---------|------------|-------|---------|
136-
| scalarplot, 1D | y | y | y,i | y | y |
137-
| vectorplot, 1D | y | y | y | y | y |
138-
| gridplot, 1D | y | y | y | y | |
139-
| scalarplot, 2D | y | y | y | (y) | y,i |
140-
| vectorplot, 2D | y | y | y | y | |
141-
| streamplot, 2D | y | y | p | n | |
142-
| gridplot, 2D | y | y,i | y | (y) | y,i |
143-
| scalarplot, 3D | y | y,i | y,i | n | y,i |
144-
| gridplot, 3D | y | y,i | y,i | n | y,i |
145-
| vectorplot, 3D | p | p | p | n | |
146-
| streamplot, 3D | | p | p | n | |
147-
| movie | n | y | n | y | |
148-
| triangulateio | y | y | n | n | n |
134+
| | PyPlot | Makie | PlutoVista | Plots | VTKView |
135+
|----------------|--------|-------|------------|-------|---------|
136+
| scalarplot, 1D | y | y | y,i | y | y |
137+
| vectorplot, 1D | y | y | y | y | y |
138+
| gridplot, 1D | y | y | y | y | |
139+
| scalarplot, 2D | y | y | y | (y) | y,i |
140+
| vectorplot, 2D | y | y | y | y | |
141+
| streamplot, 2D | y | y | p | n | |
142+
| gridplot, 2D | y | y,i | y | (y) | y,i |
143+
| scalarplot, 3D | y | y,i | y,i | n | y,i |
144+
| gridplot, 3D | y | y,i | y,i | n | y,i |
145+
| vectorplot, 3D | p | p | p | n | |
146+
| streamplot, 3D | | p | p | n | |
147+
| movie | n | y | n | y | |
148+
| triangulateio | y | y | n | n | n |
149149

150150
## Sample output
151151

@@ -155,15 +155,14 @@ and all plotting functions will do nothing.
155155

156156

157157
### [GLMakie](https://github.com/JuliaPlots/GLMakie.jl):
158-
159158
![](https://github.com/WIAS-PDELib/GridVisualize.jl/blob/main/docs/src/assets/multiscene_glmakie.png?raw=true)
160159

161160

162161
### [Plots/gr](https://github.com/JuliaPlots/Plots.jl):
163162
![](https://github.com/WIAS-PDELib/GridVisualize.jl/blob/main/docs/src/assets/multiscene_plots.png?raw=true")
164163

165164

166-
### [VTKView](https://github.com/j-fu/VTKView.jl):
165+
### [VTKView](https://github.com/j-fu/VTKView.jl) (experimental):
167166
![](https://github.com/WIAS-PDELib/GridVisualize.jl/blob/main/docs/src/assets/multiscene_vtkview.png?raw=true")
168167

169168
## vscode

docs/Project.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ ExtendableGrids = "cfc395e8-590f-11e8-1f13-43a2532b2fa8"
77
GridVisualize = "5eed8a63-0fb0-45eb-886d-8d5a387d12b8"
88
HypertextLiteral = "ac1192a8-f4b3-4bfe-ba22-af5b92cd3ab2"
99
Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
10+
MeshCat = "283c5d60-a78f-5afe-a0af-af636b173e11"
1011
Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
1112
Pluto = "c3e4b0f8-55cb-11ea-2926-15256bba5781"
1213
PlutoSliderServer = "2fc8631c-6f24-4c5b-bca7-cbb509c42db4"
@@ -16,3 +17,4 @@ PyPlot = "d330b81b-6aea-500a-939a-2ce795aea3ee"
1617
Revise = "295af30f-e4ad-537b-8983-00126c2a3abe"
1718
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
1819
Triangulate = "f7e6ffb2-c36d-4f8f-a77e-16e897189344"
20+
VTKView = "955f2c64-5fd0-11e9-0ad0-3332e913311a"

docs/make.jl

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
using Documenter, GridVisualize
22
import PlutoSliderServer # LoadError: Please import/use PlutoSliderServer.jl in order to use docplutonotebooks with `iframe=true`
33
using ExampleJuggler
4-
import CairoMakie, PlutoVista # for docstrings and graphics generated by documentet
4+
import CairoMakie, PlutoVista, MeshCat, VTKView # for docstrings and graphics generated by documentet
55
import Plots, PyPlot # for docstrings only
66
using ExtendableGrids
77
ExampleJuggler.verbose!(true)
@@ -11,10 +11,8 @@ GridVisualizeMakieExt = Base.get_extension(GridVisualize, :GridVisualizeMakieExt
1111
GridVisualizePlotsExt = Base.get_extension(GridVisualize, :GridVisualizePlotsExt)
1212
GridVisualizePlutoVistaExt = Base.get_extension(GridVisualize, :GridVisualizePlutoVistaExt)
1313
GridVisualizePyPlotExt = Base.get_extension(GridVisualize, :GridVisualizePyPlotExt)
14-
15-
# These are experimental, we exclude them from the documentation.
16-
# GridVisualizeMeshCatExt = Base.get_extension(GridVisualize, :GridVisualizeMeshCatExt)
17-
# GridVisualizeVTKViewExt = Base.get_extension(GridVisualize, :GridVisualizeVTKViewExt)
14+
GridVisualizeMeshCatExt = Base.get_extension(GridVisualize, :GridVisualizeMeshCatExt)
15+
GridVisualizeVTKViewExt = Base.get_extension(GridVisualize, :GridVisualizeVTKViewExt)
1816

1917

2018
function mkdocs()
@@ -35,8 +33,8 @@ function mkdocs()
3533
GridVisualizePlutoVistaExt,
3634
GridVisualizePyPlotExt,
3735
GridVisualizePlotsExt,
38-
# GridVisualizeVTKViewExt,
39-
# GridVisualizeMeshCatExt,
36+
GridVisualizeVTKViewExt,
37+
GridVisualizeMeshCatExt,
4038
],
4139
doctest = false,
4240
clean = false,

docs/src/privapi.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,7 @@ GridVisualize.ImplEvalSlice
5757
```
5858

5959
## Experimental
60-
There are experimental extensions for VTKView and MeshCat which are not part of the "official" API.
60+
```@docs
61+
GridVisualizeVTKViewExt
62+
GridVisualizeMeshCatExt
63+
```

0 commit comments

Comments
 (0)