Skip to content

Commit

Permalink
build based on f9c595b
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Nov 11, 2023
1 parent ead6dd3 commit d1acd41
Show file tree
Hide file tree
Showing 11 changed files with 23 additions and 23 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-10-12T20:30:10","documenter_version":"1.1.1"}}
{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-11-11T21:40:38","documenter_version":"1.1.2"}}
2 changes: 1 addition & 1 deletion dev/api/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -201,4 +201,4 @@
kwargs...
) -> Any
</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/j-fu/GridVisualize.jl">source</a></section></article><h2 id="Keyword-Arguments"><a class="docs-heading-anchor" href="#Keyword-Arguments">Keyword Arguments</a><a id="Keyword-Arguments-1"></a><a class="docs-heading-anchor-permalink" href="#Keyword-Arguments" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="GridVisualize.available_kwargs" href="#GridVisualize.available_kwargs"><code>GridVisualize.available_kwargs</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">available_kwargs()
</code></pre><p>Available kwargs for all methods of this package.</p><ul><li><p><code>show</code>: Show plot immediately. Default: <code>false</code></p></li><li><p><code>reveal</code>: Show plot immediately (same as :show). Default: <code>false</code></p></li><li><p><code>clear</code>: Clear plot before adding new content. Default: <code>true</code></p></li><li><p><code>layout</code>: Layout of plots in window. Default: <code>(1, 1)</code></p></li><li><p><code>size</code>: Plot window resolution. Default: <code>(500, 500)</code></p></li><li><p><code>legend</code>: Legend (position): one of [:none, :best, :lt, :ct, :rt, :lc, :rc, :lb, :cb, :rb]. Default: <code>none</code></p></li><li><p><code>title</code>: Plot title. Default: ``</p></li><li><p><code>xlabel</code>: x axis label. Default: <code>x</code></p></li><li><p><code>ylabel</code>: y axis label. Default: <code>y</code></p></li><li><p><code>zlabel</code>: z axis label. Default: <code>z</code></p></li><li><p><code>xlimits</code>: x axis limits. Default: <code>(1, -1)</code></p></li><li><p><code>ylimits</code>: y axis limits. Default: <code>(1, -1)</code></p></li><li><p><code>zlimits</code>: z axis limits. Default: <code>(1, -1)</code></p></li><li><p><code>limits</code>: function limits. Default: <code>(1, -1)</code></p></li><li><p><code>xscale</code>: x axis scale: one of [:log, :identity]. Default: <code>identity</code></p></li><li><p><code>yscale</code>: y axis scale: one of [:log, :identity]. Default: <code>identity</code></p></li><li><p><code>aspect</code>: XY Aspect ratio modification. Default: <code>1.0</code></p></li><li><p><code>fontsize</code>: Fontsize of titles. All others are relative to it. Default: <code>20</code></p></li><li><p><code>linewidth</code>: linewidth for isolines or 1D plots. Default: <code>2</code></p></li><li><p><code>linestyle</code>: 1D Plot linestyle: one of [:solid, :dash, :dot, :dashdot, :dashdotdot]. Default: <code>solid</code></p></li><li><p><code>markevery</code>: 1D plot marker stride. Default: <code>5</code></p></li><li><p><code>markersize</code>: 1D plot marker size. Default: <code>5</code></p></li><li><p><code>markershape</code>: 1D plot marker shape: one of [:none, :circle, :star5, :diamond, :hexagon, :cross, :xcross, :utriangle, :dtriangle, :rtriangle, :ltriangle, :pentagon, :+, :x]. Default: <code>none</code></p></li><li><p><code>color</code>: 1D plot line color. Default: <code>(0.0, 0.0, 0.0)</code></p></li><li><p><code>cellwise</code>: 1D plots cellwise; unmaintained and can be slow). Default: <code>false</code></p></li><li><p><code>label</code>: 1D plot label. Default: ``</p></li><li><p><code>levels</code>: array of isolevels or number of isolevels for contour plots. Default: <code>7</code></p></li><li><p><code>elevation</code>: 2D plot height factor for elevation. Default: <code>0.0</code></p></li><li><p><code>colorlevels</code>: 2D/3D contour plot: number of color levels. Default: <code>51</code></p></li><li><p><code>colormap</code>: 2D/3D contour plot color map (any from <a href="https://juliagraphics.github.io/ColorSchemes.jl/stable/basics/#Pre-defined-schemes">ColorSchemes.jl</a>). Default: <code>viridis</code></p></li><li><p><code>colorbar</code>: 2D/3D plot colorbar. One of [:none, :vertical, :horizontal]. Default: <code>vertical</code></p></li><li><p><code>colorbarticks</code>: number of ticks in colorbar (:default sets it equal to levels). Default: <code>default</code></p></li><li><p><code>outlinealpha</code>: 3D outline surface alpha value. Default: <code>0.05</code></p></li><li><p><code>levelalpha</code>: 3D isolevel alpha. Default: <code>0.25</code></p></li><li><p><code>planealpha</code>: 3D plane section alpha. Default: <code>0.25</code></p></li><li><p><code>tetxplane_tol</code>: tolerance for tet-plane intersection in 3D. Default: <code>0.0</code></p></li><li><p><code>spacing</code>: Spacing of quiver points in vector plot. Default: <code>default</code></p></li><li><p><code>offset</code>: Offset of quiver grid. Default: <code>default</code></p></li><li><p><code>vscale</code>: Vector field scale for quiver grid. Default: <code>1.0</code></p></li><li><p><code>vconstant</code>: Set all arrow length constant in vector plot. Default: <code>false</code></p></li><li><p><code>vnormalize</code>: Normalize vector field befor scaling. Default: <code>true</code></p></li><li><p><code>interior</code>: 3D plot interior of grid. Default: <code>true</code></p></li><li><p><code>xplanes</code>: 3D x plane positions or number thereof. Default: <code>[1.7976931348623157e308]</code></p></li><li><p><code>yplanes</code>: 3D y plane positions or number thereof. Default: <code>[1.7976931348623157e308]</code></p></li><li><p><code>zplanes</code>: 3D z plane positions or number thereof. Default: <code>[1.7976931348623157e308]</code></p></li><li><p><code>zoom</code>: Zoom level. Default: <code>1.0</code></p></li><li><p><code>gridscale</code>: grid scale factor. Default: <code>1.0</code></p></li><li><p><code>azim</code>: 3D azimuth angle (in degrees). Default: <code>-60</code></p></li><li><p><code>elev</code>: 3D elevation angle (in degrees). Default: <code>30</code></p></li><li><p><code>perspectiveness</code>: 3D perspective A number between 0 and 1, where 0 is orthographic, and 1 full perspective. Default: <code>0.25</code></p></li><li><p><code>scene3d</code>: 3D plot type of Makie scene. Alternaitve to <code>:Axis3</code> is <code>:LScene</code>. Default: <code>Axis3</code></p></li><li><p><code>fignumber</code>: Figure number (PyPlot). Default: <code>1</code></p></li><li><p><code>framepos</code>: Subplot position in frame (VTKView). Default: <code>1</code></p></li><li><p><code>subplot</code>: Private: Actual subplot. Default: <code>(1, 1)</code></p></li><li><p><code>backend</code>: Backend for PlutoVista plot. Default: <code>default</code></p></li><li><p><code>dim</code>: Data dimension for PlutoVista plot. Default: <code>1</code></p></li><li><p><code>regions</code>: List of regions to plot. Default: <code>all</code></p></li><li><p><code>species</code>: Number of species to plot or number of species in regions. Default: <code>1</code></p></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/j-fu/GridVisualize.jl">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../privapi/">Private API »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.1 on <span class="colophon-date" title="Thursday 12 October 2023 20:30">Thursday 12 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
</code></pre><p>Available kwargs for all methods of this package.</p><ul><li><p><code>show</code>: Show plot immediately. Default: <code>false</code></p></li><li><p><code>reveal</code>: Show plot immediately (same as :show). Default: <code>false</code></p></li><li><p><code>clear</code>: Clear plot before adding new content. Default: <code>true</code></p></li><li><p><code>layout</code>: Layout of plots in window. Default: <code>(1, 1)</code></p></li><li><p><code>size</code>: Plot window resolution. Default: <code>(500, 500)</code></p></li><li><p><code>legend</code>: Legend (position): one of [:none, :best, :lt, :ct, :rt, :lc, :rc, :lb, :cb, :rb]. Default: <code>none</code></p></li><li><p><code>title</code>: Plot title. Default: ``</p></li><li><p><code>xlabel</code>: x axis label. Default: <code>x</code></p></li><li><p><code>ylabel</code>: y axis label. Default: <code>y</code></p></li><li><p><code>zlabel</code>: z axis label. Default: <code>z</code></p></li><li><p><code>xlimits</code>: x axis limits. Default: <code>(1, -1)</code></p></li><li><p><code>ylimits</code>: y axis limits. Default: <code>(1, -1)</code></p></li><li><p><code>zlimits</code>: z axis limits. Default: <code>(1, -1)</code></p></li><li><p><code>limits</code>: function limits. Default: <code>(1, -1)</code></p></li><li><p><code>xscale</code>: x axis scale: one of [:log, :identity]. Default: <code>identity</code></p></li><li><p><code>yscale</code>: y axis scale: one of [:log, :identity]. Default: <code>identity</code></p></li><li><p><code>aspect</code>: XY Aspect ratio modification. Default: <code>1.0</code></p></li><li><p><code>fontsize</code>: Fontsize of titles. All others are relative to it. Default: <code>20</code></p></li><li><p><code>linewidth</code>: linewidth for isolines or 1D plots. Default: <code>2</code></p></li><li><p><code>linestyle</code>: 1D Plot linestyle: one of [:solid, :dash, :dot, :dashdot, :dashdotdot]. Default: <code>solid</code></p></li><li><p><code>markevery</code>: 1D plot marker stride. Default: <code>5</code></p></li><li><p><code>markersize</code>: 1D plot marker size. Default: <code>5</code></p></li><li><p><code>markershape</code>: 1D plot marker shape: one of [:none, :circle, :star5, :diamond, :hexagon, :cross, :xcross, :utriangle, :dtriangle, :rtriangle, :ltriangle, :pentagon, :+, :x]. Default: <code>none</code></p></li><li><p><code>color</code>: 1D plot line color. Default: <code>(0.0, 0.0, 0.0)</code></p></li><li><p><code>cellwise</code>: 1D plots cellwise; unmaintained and can be slow). Default: <code>false</code></p></li><li><p><code>label</code>: 1D plot label. Default: ``</p></li><li><p><code>levels</code>: array of isolevels or number of isolevels for contour plots. Default: <code>7</code></p></li><li><p><code>elevation</code>: 2D plot height factor for elevation. Default: <code>0.0</code></p></li><li><p><code>colorlevels</code>: 2D/3D contour plot: number of color levels. Default: <code>51</code></p></li><li><p><code>colormap</code>: 2D/3D contour plot color map (any from <a href="https://juliagraphics.github.io/ColorSchemes.jl/stable/basics/#Pre-defined-schemes">ColorSchemes.jl</a>). Default: <code>viridis</code></p></li><li><p><code>colorbar</code>: 2D/3D plot colorbar. One of [:none, :vertical, :horizontal]. Default: <code>vertical</code></p></li><li><p><code>colorbarticks</code>: number of ticks in colorbar (:default sets it equal to levels). Default: <code>default</code></p></li><li><p><code>outlinealpha</code>: 3D outline surface alpha value. Default: <code>0.05</code></p></li><li><p><code>levelalpha</code>: 3D isolevel alpha. Default: <code>0.25</code></p></li><li><p><code>planealpha</code>: 3D plane section alpha. Default: <code>0.25</code></p></li><li><p><code>tetxplane_tol</code>: tolerance for tet-plane intersection in 3D. Default: <code>0.0</code></p></li><li><p><code>spacing</code>: Spacing of quiver points in vector plot. Default: <code>default</code></p></li><li><p><code>offset</code>: Offset of quiver grid. Default: <code>default</code></p></li><li><p><code>vscale</code>: Vector field scale for quiver grid. Default: <code>1.0</code></p></li><li><p><code>vconstant</code>: Set all arrow length constant in vector plot. Default: <code>false</code></p></li><li><p><code>vnormalize</code>: Normalize vector field befor scaling. Default: <code>true</code></p></li><li><p><code>interior</code>: 3D plot interior of grid. Default: <code>true</code></p></li><li><p><code>xplanes</code>: 3D x plane positions or number thereof. Default: <code>[1.7976931348623157e308]</code></p></li><li><p><code>yplanes</code>: 3D y plane positions or number thereof. Default: <code>[1.7976931348623157e308]</code></p></li><li><p><code>zplanes</code>: 3D z plane positions or number thereof. Default: <code>[1.7976931348623157e308]</code></p></li><li><p><code>zoom</code>: Zoom level. Default: <code>1.0</code></p></li><li><p><code>gridscale</code>: grid scale factor. Default: <code>1.0</code></p></li><li><p><code>azim</code>: 3D azimuth angle (in degrees). Default: <code>-60</code></p></li><li><p><code>elev</code>: 3D elevation angle (in degrees). Default: <code>30</code></p></li><li><p><code>perspectiveness</code>: 3D perspective A number between 0 and 1, where 0 is orthographic, and 1 full perspective. Default: <code>0.25</code></p></li><li><p><code>scene3d</code>: 3D plot type of Makie scene. Alternaitve to <code>:Axis3</code> is <code>:LScene</code>. Default: <code>Axis3</code></p></li><li><p><code>fignumber</code>: Figure number (PyPlot). Default: <code>1</code></p></li><li><p><code>framepos</code>: Subplot position in frame (VTKView). Default: <code>1</code></p></li><li><p><code>subplot</code>: Private: Actual subplot. Default: <code>(1, 1)</code></p></li><li><p><code>backend</code>: Backend for PlutoVista plot. Default: <code>default</code></p></li><li><p><code>dim</code>: Data dimension for PlutoVista plot. Default: <code>1</code></p></li><li><p><code>regions</code>: List of regions to plot. Default: <code>all</code></p></li><li><p><code>species</code>: Number of species to plot or number of species in regions. Default: <code>1</code></p></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/j-fu/GridVisualize.jl">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../privapi/">Private API »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.2 on <span class="colophon-date" title="Saturday 11 November 2023 21:40">Saturday 11 November 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/examples/plotting/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -222,4 +222,4 @@
colormap,
kwargs...,
)
end</code></pre><p><img src="../plotting_jfunc3d.svg" alt/></p><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../privapi/">« Private API</a><a class="docs-footer-nextpage" href="../pluto/">Pluto notebook »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.1 on <span class="colophon-date" title="Thursday 12 October 2023 20:30">Thursday 12 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
end</code></pre><p><img src="../plotting_jfunc3d.svg" alt/></p><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../privapi/">« Private API</a><a class="docs-footer-nextpage" href="../pluto/">Pluto notebook »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.2 on <span class="colophon-date" title="Saturday 11 November 2023 21:40">Saturday 11 November 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
6 changes: 3 additions & 3 deletions dev/examples/plotting_func2d.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions dev/examples/plotting_func3d.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions dev/examples/plotting_grid3d.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions dev/examples/plotting_multiscene.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit d1acd41

Please sign in to comment.