-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update docs, changelog, add contributing.md
- Loading branch information
Showing
4 changed files
with
132 additions
and
137 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
## Hints for contributors | ||
Non-experimental backends are: Makie, PyPlot, PlutoVista, partially Plots. These should be checked before | ||
submitting a pull request. | ||
|
||
As it is not easy to install a decent CI for graphical interfaces, visual checking can be performed in the following way. | ||
Create an environment which contains ExtendableGrids, GLMakie, PyPlot, PlutoVista, Plots and PlutoUI, and develops GridVisualize. | ||
A good option is to create a "shared environment" `@GridVisualize` (assuming GridVisualize is worked on in `JULIA_PKG_DEVDIR`): | ||
``` | ||
$ julia --project=@GridVisualize | ||
$ julia> ] # Enter Pkg mode | ||
$ (@GridVisualize) pkg> add GLMakie, PyPlot, PlutoVista, Plots, PlutoUI, ExtendableGrids | ||
$ (@GridVisualize) pkg> dev GridVisualize | ||
$ julia> using GridVisualize GLMakie, PyPlot, Plots | ||
$ julia> include("examples/plotting.jl") | ||
$ julia> plotting_multiscene(Plotter=PyPlot) | ||
$ julia> plotting_multiscene(Plotter=Plots) | ||
$ julia> plotting_multiscene(Plotter=GLMakie) | ||
``` | ||
For checking the PlutoVista backend, perform in the same environment | ||
``` | ||
julia> using Pluto | ||
julia> ENV["PLUTO_PROJECT"]=Base.active_project() | ||
julia> Pluto.run(notebook="examples/plutovista.jl") | ||
``` | ||
|
Oops, something went wrong.