Skip to content

Commit

Permalink
update limks after moving to WIAS-PDELib org
Browse files Browse the repository at this point in the history
  • Loading branch information
j-fu committed Nov 2, 2024
1 parent fcfdb7a commit 8027678
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 16 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Changelog

## [1.8.1] - 2024-11-02
- update links after move to WIAS-PDELib org

## [1.8.0] - 2024-09-29

Expand Down
4 changes: 2 additions & 2 deletions Project.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "GridVisualize"
uuid = "5eed8a63-0fb0-45eb-886d-8d5a387d12b8"
authors = ["Juergen Fuhrmann <[email protected]>"]
version = "1.8"
version = "1.8.1"

[deps]
ColorSchemes = "35d6a980-a343-548e-a6ea-1d62b119f2f4"
Expand All @@ -23,7 +23,7 @@ StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
[compat]
CairoMakie = "0.11.3, 0.12"
ColorSchemes = "3"
Colors = "0.12,1"
Colors = "0.12,0.13,1"
DocStringExtensions = "0.8,0.9"
ElasticArrays = "1"
ExtendableGrids = "1.10"
Expand Down
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
[![Build status](https://github.com/j-fu/GridVisualize.jl/workflows/linux-macos-windows/badge.svg)](https://github.com/j-fu/GridVisualize.jl/actions)
[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://j-fu.github.io/GridVisualize.jl/stable)
[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://j-fu.github.io/GridVisualize.jl/dev)
[![Build status](https://github.com/WIAS-PDELib/GridVisualize.jl/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/WIAS-PDELib/GridVisualize.jl/actions/workflows/ci.yml?query=branch%3Amaster)
[![](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)

GridVisualize
=============

Plotting companion module for [ExtendableGrids.jl](https://github.com/j-fu/ExtendableGrids.jl)
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, PyPlot, and PlutoVista. Plots is only partially supported (1D and 2D rectangular grids).
Expand All @@ -29,7 +29,7 @@ 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 currenly available for 2D only.

The `grid` argument should be an `ExtendableGrid` as defined by the [ExtendableGrids.jl](https://github.com/j-fu/ExtendableGrids.jl) package.
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
Expand All @@ -39,7 +39,7 @@ Instead of `grid`, the following arguments can be passed in order to describe a
a `dim`-dimensional simplex grid with `nn` nodes and `nc` simplices.

Plot appearance can be tweaked by a number of
[keyword arguments](https://j-fu.github.io/GridVisualize.jl/dev/api/#GridVisualize.available_kwargs).
[keyword arguments](https://WIAS-PDELib.github.io/GridVisualize.jl/dev/api/#GridVisualize.available_kwargs).

### Plotters
Plotters can be e.g. Plots, PyPlot, GLMakie, CairoMakie PlutoVista - we pass the module exported
Expand Down Expand Up @@ -150,20 +150,20 @@ and all plotting functions will do nothing.


### [PyPlot](https://github.com/JuliaPy/PyPlot.jl):
![](https://github.com/j-fu/GridVisualize.jl/blob/main/docs/src/assets/multiscene_pyplot.png?raw=true)
![](https://github.com/WIAS-PDELib/GridVisualize.jl/blob/main/docs/src/assets/multiscene_pyplot.png?raw=true)


### [GLMakie](https://github.com/JuliaPlots/GLMakie.jl):

![](https://github.com/j-fu/GridVisualize.jl/blob/main/docs/src/assets/multiscene_glmakie.png?raw=true)
![](https://github.com/WIAS-PDELib/GridVisualize.jl/blob/main/docs/src/assets/multiscene_glmakie.png?raw=true)


### [Plots/gr](https://github.com/JuliaPlots/Plots.jl):
![](https://github.com/j-fu/GridVisualize.jl/blob/main/docs/src/assets/multiscene_plots.png?raw=true")
![](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):
![](https://github.com/j-fu/GridVisualize.jl/blob/main/docs/src/assets/multiscene_vtkview.png?raw=true")
![](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
Expand All @@ -179,8 +179,8 @@ Plotting in Pluto notebooks for CairoMakie, PyPlot, Plots, GLMakie is working, W

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/j-fu/GridVisualize.jl/main/examples/plutovista.jl),
[html](https://j-fu.github.io/GridVisualize.jl/dev/plutovista.html).
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
Expand Down
4 changes: 2 additions & 2 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ function mkdocs()
doctest = false,
clean = false,
authors = "J. Fuhrmann",
repo = "https://github.com/j-fu/GridVisualize.jl",
repo = "https://github.com/WIAS-PDELib/GridVisualize.jl",
pages = [
"Home" => "index.md",
"Public API" => "api.md",
Expand All @@ -46,4 +46,4 @@ end

mkdocs()

deploydocs(; repo = "github.com/j-fu/GridVisualize.jl.git", devbranch = "main")
deploydocs(; repo = "github.com/WIAS-PDELib/GridVisualize.jl.git", devbranch = "main")

2 comments on commit 8027678

@j-fu
Copy link
Member Author

@j-fu j-fu commented on 8027678 Nov 2, 2024

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/118579

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

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 v1.8.1 -m "<description of version>" 802767849086924239095286ce151295f3669d23
git push origin v1.8.1

Please sign in to comment.