Merge branch 'main' into fix/pyplot

CHANGELOG.md

@@ -1,67 +1,73 @@
-# Changelog
-
-## [unreleased]
-
-### Added
-
-- `gridplot` with `GLMakie` and `PyPlot` now annotates the color bars with `boundary regions` and `cell regions`
-
-- Unit test for `PyPlot` and `PlutoVista`
-
-## [1.9.0] - 2024-11-25
-
-### Added
-
-- new key word argument `show_colorbar` (default=true) to toggle the color bar next to grid plots
-
-### Fixed
-
-- removed dependency on type piracy of Colors.RGB
-
-## [1.8.2] - 2024-11-08
-
-### Fixed
-
-- Fix GLMakie region colorbar in 2D/3D Plots (#23)
-
-## [1.8.1] - 2024-11-02
-- update links after move to WIAS-PDELib org
-
-## [1.8.0] - 2024-09-29
-
-- Allow plotting using grids without boundary info
-
-- Add dispatches for plotting with 'coord, cellnodes'
-
-
-## [1.7.0] - 2024-06-18
-
-- Add :cellcoloring keyword for handling partitioned grids
-
-- Upgrade project.toml, dependencies
-
-- Fix cellcolor numbering
-
-- Remove nightly from ci due to pluto problem
-
-- Merge pull request #27 from j-fu/handle-partitioning
-
-Handle partitioning
-
-## [1.6.0] - 2024-05-24
-
-* require Julia >= 1.9
-
-* allow for Makie 0.21;
-
-See also https://blog.makie.org/blogposts/v0.21/
-
-
-
-## [1.5.0] - 2023-12-09
-
-- Gridscale etc (#20)
-
+# Changelog
+
+## [unreleased]
+
+### Added
+
+- `gridplot` with `GLMakie` and `PyPlot` now annotates the color bars with `boundary regions` and `cell regions`
+
+- Unit test for `PyPlot` and `PlutoVista`
+
+- unit test for undocumented names
+
+### Removed
+
+- dangling exported function `backend!`
+
+## [1.9.0] - 2024-11-25
+
+### Added
+
+- new key word argument `show_colorbar` (default=true) to toggle the color bar next to grid plots
+
+### Fixed
+
+- removed dependency on type piracy of Colors.RGB
+
+## [1.8.2] - 2024-11-08
+
+### Fixed
+
+- Fix GLMakie region colorbar in 2D/3D Plots (#23)
+
+## [1.8.1] - 2024-11-02
+- update links after move to WIAS-PDELib org
+
+## [1.8.0] - 2024-09-29
+
+- Allow plotting using grids without boundary info
+
+- Add dispatches for plotting with 'coord, cellnodes'
+
+
+## [1.7.0] - 2024-06-18
+
+- Add :cellcoloring keyword for handling partitioned grids
+
+- Upgrade project.toml, dependencies
+
+- Fix cellcolor numbering
+
+- Remove nightly from ci due to pluto problem
+
+- Merge pull request #27 from j-fu/handle-partitioning
+
+Handle partitioning
+
+## [1.6.0] - 2024-05-24
+
+* require Julia >= 1.9
+
+* allow for Makie 0.21;
+
+See also https://blog.makie.org/blogposts/v0.21/
+
+
+
+## [1.5.0] - 2023-12-09
+
+- Gridscale etc (#20)
+
 Some updates, fixes:
 
 * gridscale for plutovista, pyplot, makie,plots
@@ -76,53 +82,53 @@ Some updates, fixes:
 
 * Add customplot
 
-
-
-## [1.4.0] - 2023-12-05
-
-- Prevent PyPlot from normalizing quiver vectors
-
-- Pin CairoMakie version due to https://github.com/MakieOrg/Makie.jl/issues/3440
-
-- Add warnings for functionality not implemented in Plots
-
-- Bump CairoMakie dependency
-
-- Add streamplot for Makie
-
-- Remove another .px_area
-
-- Update multiscene plot for makie
-
-
-
-## [1.3.0] - 2023-11-15
-
-- Update Makie, GridVisualizeTools versions
-
-## [1.2.0] - 2023-11-11
-
-- Fix notebook html generation
-
-- Bgcolor->backgroundcolor in makie.jl
-
-- Add compat for stdlibs, bump minor version
-
-
-## [1.1.7] - 2023-10-12
-
-- Sets default value false for kwarg vconstant introduced in 1.15 (#18)
-
-Co-authored-by: Christian Merdon <[email protected]>
-- Fix Documenter v1 issues
-
-
-## [1.1.5] - 2023-09-11
-
-- Allow for PlutVista 1.0
-
-- Improved PyPlot backend: (#17)
-
+
+
+## [1.4.0] - 2023-12-05
+
+- Prevent PyPlot from normalizing quiver vectors
+
+- Pin CairoMakie version due to https://github.com/MakieOrg/Makie.jl/issues/3440
+
+- Add warnings for functionality not implemented in Plots
+
+- Bump CairoMakie dependency
+
+- Add streamplot for Makie
+
+- Remove another .px_area
+
+- Update multiscene plot for makie
+
+
+
+## [1.3.0] - 2023-11-15
+
+- Update Makie, GridVisualizeTools versions
+
+## [1.2.0] - 2023-11-11
+
+- Fix notebook html generation
+
+- Bgcolor->backgroundcolor in makie.jl
+
+- Add compat for stdlibs, bump minor version
+
+
+## [1.1.7] - 2023-10-12
+
+- Sets default value false for kwarg vconstant introduced in 1.15 (#18)
+
+Co-authored-by: Christian Merdon <[email protected]>
+- Fix Documenter v1 issues
+
+
+## [1.1.5] - 2023-09-11
+
+- Allow for PlutVista 1.0
+
+- Improved PyPlot backend: (#17)
+
 * better fontsize recognition
 
 * correct fig sizes
@@ -139,21 +145,21 @@ Co-authored-by: Christian Merdon <[email protected]>
 
 * added density argument to streamplot
 
-
-
-## [1.1.0] - 2023-06-02
-
-- Add weakdeps + compat for Makie & co to Project.toml
-
-- Enable levelalpha/planealpha for makie
-fix colorbarticks
-
-- Try to fix isoline rendering in makie 2d
-
-
-
-## [1.0.0] - 2023-02-05
-
-- Subgridplots (#16)
-
+
+
+## [1.1.0] - 2023-06-02
+
+- Add weakdeps + compat for Makie & co to Project.toml
+
+- Enable levelalpha/planealpha for makie
+fix colorbarticks
+
+- Try to fix isoline rendering in makie 2d
+
+
+
+## [1.0.0] - 2023-02-05
+
+- Subgridplots (#16)
+
 Handle plots of discontinuous functions in Makie,Pyplot, PlutoVista

README.md

@@ -1,6 +1,7 @@
 [![Build status](https://github.com/WIAS-PDELib/GridVisualize.jl/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/WIAS-PDELib/GridVisualize.jl/actions/workflows/ci.yml?query=branch%3Amain)
 [![](https://img.shields.io/badge/docs-stable-blue.svg)](https://WIAS-PDELib.github.io/GridVisualize.jl/stable)
 [![](https://img.shields.io/badge/docs-dev-blue.svg)](https://WIAS-PDELib.github.io/GridVisualize.jl/dev)
+[![code style: runic](https://img.shields.io/badge/code_style-%E1%9A%B1%E1%9A%A2%E1%9A%BE%E1%9B%81%E1%9A%B2-black)](https://github.com/fredrikekre/Runic.jl)
 
 GridVisualize
 =============

docs/src/api.md

@@ -61,3 +61,8 @@ available_kwargs
 vectorsample
 quiverdata
 ```
+
+## Creating movies
+```@docs
+movie
+```

docs/src/index.md

@@ -1,6 +1,5 @@
-````@eval
-using Markdown
-Markdown.parse("""
-$(read("../../README.md",String))
-""")
-````
+# GridVisualize.jl
+
+```@docs
+GridVisualize
+```

src/GridVisualize.jl

@@ -1,3 +1,8 @@
+"""
+    GridVisualize
+
+$(read(joinpath(@__DIR__, "..", "README.md"), String))
+"""
 module GridVisualize
 
 using Printf
@@ -31,7 +36,7 @@ export gridplot, gridplot!
 export vectorplot, vectorplot!
 export streamplot, streamplot!
 export customplot, customplot!
-export save, reveal, backend!
+export save, reveal
 export isplots, isvtkview, ispyplot, ismakie, isplutovista
 export GridVisualizer, SubVisualizer
 export plottertype, available_kwargs

src/makie.jl

@@ -77,6 +77,12 @@ function save(fname, scene, XMakie, ::Type{MakieType})
     return isnothing(scene) ? nothing : XMakie.save(fname, scene)
 end
 
+
+"""
+    movie( func, vis::GridVisualizer, ::Type{MakieType}; file = nothing, format = "gif", kwargs... )
+
+Record a movie with GLMakie backend. MP4 files and gifs can be created.
+"""
 function movie(
         func,
         vis::GridVisualizer,

src/plots.jl

@@ -46,6 +46,11 @@ function save(fname, scene, Plots, ::Type{PlotsType})
     return isnothing(scene) ? nothing : Plots.savefig(scene, fname)
 end
 
+"""
+    movie( func, vis::GridVisualizer, ::Type{PlotsType}; file = nothing, format = "gif", kwargs... )
+
+Record a movie with Plots backend. MP4 files and gifs can be created.
+"""
 function movie(
         func,
         vis::GridVisualizer,

test/runtests.jl

@@ -24,3 +24,10 @@ for Plotter in [PyPlot, PlutoVista]
         end
     end
 end
+
+
+if isdefined(Docs, :undocumented_names) # >=1.11
+    @testset "UndocumentedNames" begin
+        @test isempty(Docs.undocumented_names(GridVisualize))
+    end
+end