logankilpatrick / MakieGallery.jl

Documentation and Example Gallery for Makie

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Makie.jl

Build status: Build Status

Gallery Generated With this Package

Examples for Makie:

Mouse interaction:

Animating a surface:

Complex examples

Running examples in the REPL:

julia> using MakieGallery
julia> database = MakieGallery.load_database();
julia> database[1].title # can be used e.g. for filter(x-> x.title == "...", database)
"Tutorial simple scatter"
julia> database[1] # pretty printing :) 
...
 x = rand(10)
 y = rand(10)
 colors = rand(10)
 scene = scatter(x, y, color = colors)
...
julia> using Makie
julia> MakieGallery.eval_example(database[1]) # run it!

Developing this package

Adding an example

MakieGallery hosts a lot of examples describing how to use Makie.jl.
To add a standalone example, find the file where it fits best, and add a new @cell entry (or a new @block entry if you want to add more examples in the future).
If you want to add multiple examples, you probably want to add a new @block, or even a new file.

Building the documentation

MakieGallery hosts documentation for Makie.jl.
However, this documentation requires the reference images to be downloaded in the home directory (configurability via an environment variable is planned).
You can get the reference images from github.com/SimonDanisch/ReferenceImages - it's a 340 MB repository, so you may want to shallow clone.

About

Documentation and Example Gallery for Makie

License:Other


Languages

Language:Julia 92.7%Language:JavaScript 7.3%