Skip to content

Commit

Permalink
build based on bb8f72d
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Oct 25, 2024
1 parent 6aa442d commit 6543cf3
Show file tree
Hide file tree
Showing 9 changed files with 41 additions and 22 deletions.
25 changes: 22 additions & 3 deletions dev/dimension/index.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · PeriodicGraphs.jl</title><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.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/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="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>PeriodicGraphs.jl</a></span></div><form class="docs-search" action="search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Home</a><ul class="internal"><li><a class="tocitem" href="#Usages"><span>Usages</span></a></li><li><a class="tocitem" href="#Package-installation"><span>Package installation</span></a></li></ul></li><li><span class="tocitem">Basics</span><ul><li><a class="tocitem" href="types/">Types</a></li><li><a class="tocitem" href="neighborhood/">Neighborhood</a></li></ul></li><li><a class="tocitem" href="symmetries/">Symmetries</a></li><li><span class="tocitem">Algorithms</span><ul><li><a class="tocitem" href="dimension/">Dimensionality</a></li><li><a class="tocitem" href="rings/">Rings</a></li></ul></li><li><a class="tocitem" href="utilities/">Utilities</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"><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-edit-link" href="https://github.com/Liozou/PeriodicGraphs.jl/blob/master/docs/src/index.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="PeriodicGraphs.jl"><a class="docs-heading-anchor" href="#PeriodicGraphs.jl">PeriodicGraphs.jl</a><a id="PeriodicGraphs.jl-1"></a><a class="docs-heading-anchor-permalink" href="#PeriodicGraphs.jl" title="Permalink"></a></h1><p>A Julia package for the manipulation of periodic graphs.</p><h2 id="Usages"><a class="docs-heading-anchor" href="#Usages">Usages</a><a id="Usages-1"></a><a class="docs-heading-anchor-permalink" href="#Usages" title="Permalink"></a></h2><p><code>PeriodicGraphs.jl</code> defines types and algorithms useful for the manipulation of <code>N</code>-periodic undirected graphs, with <code>N</code> known at compile-time. It extends <code>Graphs.jl</code> by providing the new <code>PeriodicGraph</code> type which implements the <code>AbstractGraph</code> API. It also provides an API for the manipulation of symmetries.</p><p>This package serves as support for the <code>PeriodicGraphEmbeddings.jl</code> library, which focuses on euclidean embeddings of periodic graphs, and for <code>CrystalNets.jl</code> for the manipulation and identification of crystal nets, which are 2 or 3-periodic graphs.</p><h2 id="Package-installation"><a class="docs-heading-anchor" href="#Package-installation">Package installation</a><a id="Package-installation-1"></a><a class="docs-heading-anchor-permalink" href="#Package-installation" title="Permalink"></a></h2><p>The installation follows the usual procedure. Start by downloading and installing <a href="https://julialang.org/">Julia</a> (v1.6 or higher for <code>PeriodicGraphs.jl</code>). Then, either</p><ul><li>open the Julia REPL and enter the package manager by typing <code>]</code>, then install <code>PeriodicGraphs.jl</code> by entering:<pre><code class="language-julia hljs">pkg&gt; add PeriodicGraphs</code></pre></li><li>alternatively, you can do it from a shell by executing:<pre><code class="language-bash hljs">julia -e &#39;import Pkg; Pkg.add(&quot;PeriodicGraphs&quot;)</code></pre></li></ul><p>To use the package, open a REPL and enter</p><pre><code class="language-julia hljs">julia&gt; using PeriodicGraphs</code></pre></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="types/">Types »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Friday 7 June 2024 09:11">Friday 7 June 2024</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · PeriodicGraphs.jl</title><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.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/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="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>PeriodicGraphs.jl</a></span></div><form class="docs-search" action="search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Home</a><ul class="internal"><li><a class="tocitem" href="#Usages"><span>Usages</span></a></li><li><a class="tocitem" href="#Package-installation"><span>Package installation</span></a></li></ul></li><li><span class="tocitem">Basics</span><ul><li><a class="tocitem" href="types/">Types</a></li><li><a class="tocitem" href="neighborhood/">Neighborhood</a></li></ul></li><li><a class="tocitem" href="symmetries/">Symmetries</a></li><li><span class="tocitem">Algorithms</span><ul><li><a class="tocitem" href="dimension/">Dimensionality</a></li><li><a class="tocitem" href="rings/">Rings</a></li></ul></li><li><a class="tocitem" href="utilities/">Utilities</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"><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-edit-link" href="https://github.com/Liozou/PeriodicGraphs.jl/blob/master/docs/src/index.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="PeriodicGraphs.jl"><a class="docs-heading-anchor" href="#PeriodicGraphs.jl">PeriodicGraphs.jl</a><a id="PeriodicGraphs.jl-1"></a><a class="docs-heading-anchor-permalink" href="#PeriodicGraphs.jl" title="Permalink"></a></h1><p>A Julia package for the manipulation of periodic graphs.</p><h2 id="Usages"><a class="docs-heading-anchor" href="#Usages">Usages</a><a id="Usages-1"></a><a class="docs-heading-anchor-permalink" href="#Usages" title="Permalink"></a></h2><p><code>PeriodicGraphs.jl</code> defines types and algorithms useful for the manipulation of <code>N</code>-periodic undirected graphs, with <code>N</code> known at compile-time. It extends <code>Graphs.jl</code> by providing the new <code>PeriodicGraph</code> type which implements the <code>AbstractGraph</code> API. It also provides an API for the manipulation of symmetries.</p><p>This package serves as support for the <code>PeriodicGraphEmbeddings.jl</code> library, which focuses on euclidean embeddings of periodic graphs, and for <code>CrystalNets.jl</code> for the manipulation and identification of crystal nets, which are 2 or 3-periodic graphs.</p><h2 id="Package-installation"><a class="docs-heading-anchor" href="#Package-installation">Package installation</a><a id="Package-installation-1"></a><a class="docs-heading-anchor-permalink" href="#Package-installation" title="Permalink"></a></h2><p>The installation follows the usual procedure. Start by downloading and installing <a href="https://julialang.org/">Julia</a> (v1.6 or higher for <code>PeriodicGraphs.jl</code>). Then, either</p><ul><li>open the Julia REPL and enter the package manager by typing <code>]</code>, then install <code>PeriodicGraphs.jl</code> by entering:<pre><code class="language-julia hljs">pkg&gt; add PeriodicGraphs</code></pre></li><li>alternatively, you can do it from a shell by executing:<pre><code class="language-bash hljs">julia -e &#39;import Pkg; Pkg.add(&quot;PeriodicGraphs&quot;)</code></pre></li></ul><p>To use the package, open a REPL and enter</p><pre><code class="language-julia hljs">julia&gt; using PeriodicGraphs</code></pre></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="types/">Types »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Friday 25 October 2024 22:24">Friday 25 October 2024</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 6543cf3

Please sign in to comment.