Skip to content

Commit

Permalink
build based on cb50e0f
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Jan 26, 2024
1 parent 5b2c453 commit fa47a15
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 5 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.10.0","generation_timestamp":"2024-01-26T18:16:51","documenter_version":"1.2.1"}}
{"documenter":{"julia_version":"1.10.0","generation_timestamp":"2024-01-26T18:23:31","documenter_version":"1.2.1"}}
2 changes: 1 addition & 1 deletion dev/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · Smesh.jl</title><meta name="title" content="Home · Smesh.jl"/><meta property="og:title" content="Home · Smesh.jl"/><meta property="twitter:title" content="Home · Smesh.jl"/><meta name="description" content="Documentation for Smesh.jl."/><meta property="og:description" content="Documentation for Smesh.jl."/><meta property="twitter:description" content="Documentation for Smesh.jl."/><meta property="og:url" content="https://trixi-framework.github.io/Smesh.jl/stable/"/><meta property="twitter:url" content="https://trixi-framework.github.io/Smesh.jl/stable/"/><link rel="canonical" href="https://trixi-framework.github.io/Smesh.jl/stable/"/><script data-outdated-warner src="assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="search_index.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href>Smesh.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Home</a><ul class="internal"><li><a class="tocitem" href="#Getting-started"><span>Getting started</span></a></li><li><a class="tocitem" href="#Authors"><span>Authors</span></a></li><li><a class="tocitem" href="#License-and-contributing"><span>License and contributing</span></a></li></ul></li><li><span class="tocitem">Advanced topics &amp; developers</span><ul><li><a class="tocitem" href="release-management/">Release management</a></li></ul></li><li><a class="tocitem" href="reference/">API reference</a></li><li><a class="tocitem" href="license/">License</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/trixi-framework/Smesh.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/trixi-framework/Smesh.jl/blob/main/README.md" title="View source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Smesh.jl"><a class="docs-heading-anchor" href="#Smesh.jl">Smesh.jl</a><a id="Smesh.jl-1"></a><a class="docs-heading-anchor-permalink" href="#Smesh.jl" title="Permalink"></a></h1><p><a href="https://trixi-framework.github.io/Smesh.jl/stable"><img src="https://img.shields.io/badge/docs-stable-blue.svg" alt="Docs-stable"/></a> <a href="https://trixi-framework.github.io/Smesh.jl/dev"><img src="https://img.shields.io/badge/docs-dev-blue.svg" alt="Docs-dev"/></a> <a href="https://github.com/trixi-framework/Smesh.jl/actions?query=workflow%3ACI"><img src="https://github.com/trixi-framework/Smesh.jl/workflows/CI/badge.svg" alt="Build Status"/></a> <a href="https://coveralls.io/github/trixi-framework/Smesh.jl"><img src="https://coveralls.io/repos/github/trixi-framework/Smesh.jl/badge.svg" alt="Coveralls"/></a> <a href="https://codecov.io/gh/trixi-framework/Smesh.jl"><img src="https://codecov.io/gh/trixi-framework/Smesh.jl/branch/main/graph/badge.svg" alt="Codecov"/></a> <a href="https://opensource.org/license/mit/"><img src="https://img.shields.io/badge/License-MIT-success.svg" alt="License: MIT"/></a></p><p>Smesh.jl is a Julia wrapper packagae for <a href="https://github.com/trixi-framework/smesh">smesh</a>, a simple Fortran package for generating and handling unstructured triangular and polygonal meshes.</p><h2 id="Getting-started"><a class="docs-heading-anchor" href="#Getting-started">Getting started</a><a id="Getting-started-1"></a><a class="docs-heading-anchor-permalink" href="#Getting-started" title="Permalink"></a></h2><h3 id="Prerequisites"><a class="docs-heading-anchor" href="#Prerequisites">Prerequisites</a><a id="Prerequisites-1"></a><a class="docs-heading-anchor-permalink" href="#Prerequisites" title="Permalink"></a></h3><p>If you have not yet installed Julia, please <a href="https://julialang.org/downloads/platform/">follow the instructions for your operating system</a>. <a href="https://github.com/trixi-framewor/Smesh.jl">Smesh.jl</a> works with Julia v1.8 and later on Linux, macOS and Windows platforms.</p><p><em>Note: On pre-Apple Silicon systems with macOS, Julia v1.10 or later is required.</em></p><h3 id="Installation"><a class="docs-heading-anchor" href="#Installation">Installation</a><a id="Installation-1"></a><a class="docs-heading-anchor-permalink" href="#Installation" title="Permalink"></a></h3><p>Since Smesh.jl is a not registered Julia package yet, you can install it by executing the following commands in the Julia REPL:</p><pre><code class="language-julia hljs">julia&gt; import Pkg; Pkg.add(&quot;https://github.com/trixi-framework/Smesh.jl&quot;)</code></pre><p>By default, Smesh.jll uses pre-compiled binaries of the smesh package that will get automatically installed when obtaining Smesh.jl. However, you can also make use of a local smesh build. For this, create a <code>LocalPreferences.toml</code> file next to your <code>Project.toml</code> for the project in which you use Smesh.jl. It should have the following content:</p><ul><li>On Linux:<pre><code class="language-toml hljs">[Smesh]
libsmesh = &quot;&lt;smesh-install-prefix&gt;/lib/libsmesh.so&quot;</code></pre></li><li>On macOS:<pre><code class="language-toml hljs">[Smesh]
libsmesh = &quot;&lt;smesh-install-prefix&gt;/lib/libsmesh.dylib&quot;</code></pre></li><li>On Windows:<pre><code class="language-toml hljs">[Smesh]
libsmesh = &quot;&lt;smesh-install-prefix&gt;/bin/libsmesh.dll&quot;</code></pre></li></ul><p>Where <code>&lt;smesh-install-prefix&gt;</code> is where you have installed the local smesh build.</p><h3 id="Usage"><a class="docs-heading-anchor" href="#Usage">Usage</a><a id="Usage-1"></a><a class="docs-heading-anchor-permalink" href="#Usage" title="Permalink"></a></h3><p>The easiest way to get started is to run one of the examples from the <a href="https://github.com/trixi-framework/Smesh.jl/tree/main/examples"><code>examples</code></a> directory by <code>include</code>ing them in Julia, e.g., ``` julia&gt; using Smesh</p><p>julia&gt; include(joinpath(pkgdir(Smesh), &quot;examples&quot;, &quot;build<em>delaunay</em>triangulation.jl&quot;)) Computing Delaunay triangulation. Triangulation elements: 2 Total flipped edges: 0 Average search time: 1.25 Flips/triangle: 0.00 Flips/node: 0.00 3×2 Matrix{Int64}: 3 1 1 3 2 4 ```</p><h2 id="Authors"><a class="docs-heading-anchor" href="#Authors">Authors</a><a id="Authors-1"></a><a class="docs-heading-anchor-permalink" href="#Authors" title="Permalink"></a></h2><p>Smesh.jl was initiated by <a href="https://www.mi.uni-koeln.de/NumSim/dr-simone-chiocchetti/">Simone Chiocchetti</a> (University of Cologne, Germany), <a href="https://www.mi.uni-koeln.de/NumSim/benjamin-bolm/">Benjamin Bolm</a> (University of Cologne, Germany), and <a href="https://lakemper.eu">Michael Schlottke-Lakemper</a> (RWTH Aachen University/High-Performance Computing Center Stuttgart (HLRS), Germany) who are also its principal maintainers.</p><h2 id="License-and-contributing"><a class="docs-heading-anchor" href="#License-and-contributing">License and contributing</a><a id="License-and-contributing-1"></a><a class="docs-heading-anchor-permalink" href="#License-and-contributing" title="Permalink"></a></h2><p>Smesh.jl and smesh itself are available under the MIT license (see <a href="license/#License">License</a>). Contributions by the community are very welcome!</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="release-management/">Release management »</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.2.1 on <span class="colophon-date" title="Friday 26 January 2024 18:16">Friday 26 January 2024</span>. Using Julia version 1.10.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
libsmesh = &quot;&lt;smesh-install-prefix&gt;/bin/libsmesh.dll&quot;</code></pre></li></ul><p>Where <code>&lt;smesh-install-prefix&gt;</code> is where you have installed the local smesh build.</p><h3 id="Usage"><a class="docs-heading-anchor" href="#Usage">Usage</a><a id="Usage-1"></a><a class="docs-heading-anchor-permalink" href="#Usage" title="Permalink"></a></h3><p>The easiest way to get started is to run one of the examples from the <a href="https://github.com/trixi-framework/Smesh.jl/tree/main/examples"><code>examples</code></a> directory by <code>include</code>ing them in Julia, e.g., ``` julia&gt; using Smesh</p><p>julia&gt; include(joinpath(pkgdir(Smesh), &quot;examples&quot;, &quot;build<em>delaunay</em>triangulation.jl&quot;)) Computing Delaunay triangulation. Triangulation elements: 2 Total flipped edges: 0 Average search time: 1.25 Flips/triangle: 0.00 Flips/node: 0.00 3×2 Matrix{Int64}: 3 1 1 3 2 4 ```</p><h2 id="Authors"><a class="docs-heading-anchor" href="#Authors">Authors</a><a id="Authors-1"></a><a class="docs-heading-anchor-permalink" href="#Authors" title="Permalink"></a></h2><p>Smesh.jl was initiated by <a href="https://www.mi.uni-koeln.de/NumSim/dr-simone-chiocchetti/">Simone Chiocchetti</a> (University of Cologne, Germany), <a href="https://www.mi.uni-koeln.de/NumSim/benjamin-bolm/">Benjamin Bolm</a> (University of Cologne, Germany), and <a href="https://lakemper.eu">Michael Schlottke-Lakemper</a> (RWTH Aachen University/High-Performance Computing Center Stuttgart (HLRS), Germany) who are also its principal maintainers.</p><h2 id="License-and-contributing"><a class="docs-heading-anchor" href="#License-and-contributing">License and contributing</a><a id="License-and-contributing-1"></a><a class="docs-heading-anchor-permalink" href="#License-and-contributing" title="Permalink"></a></h2><p>Smesh.jl and smesh itself are available under the MIT license (see <a href="license/#License">License</a>). Contributions by the community are very welcome!</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="release-management/">Release management »</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.2.1 on <span class="colophon-date" title="Friday 26 January 2024 18:23">Friday 26 January 2024</span>. Using Julia version 1.10.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit fa47a15

Please sign in to comment.