Skip to content

Commit

Permalink
build based on 9b4ac0b
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Jun 5, 2024
1 parent 956aa6b commit c105910
Show file tree
Hide file tree
Showing 6 changed files with 46 additions and 46 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.4","generation_timestamp":"2024-06-05T15:39:42","documenter_version":"1.4.1"}}
{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2024-06-05T15:41:42","documenter_version":"1.4.1"}}
84 changes: 42 additions & 42 deletions dev/api/index.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/how-to-run-the-examples/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>How to run the examples · PotentialLearning.jl</title><meta name="title" content="How to run the examples · PotentialLearning.jl"/><meta property="og:title" content="How to run the examples · PotentialLearning.jl"/><meta property="twitter:title" content="How to run the examples · PotentialLearning.jl"/><meta name="description" content="Documentation for PotentialLearning.jl."/><meta property="og:description" content="Documentation for PotentialLearning.jl."/><meta property="twitter:description" content="Documentation for PotentialLearning.jl."/><meta property="og:url" content="https://cesmix-mit.github.io/PotentialLearning.jl/how-to-run-the-examples/"/><meta property="twitter:url" content="https://cesmix-mit.github.io/PotentialLearning.jl/how-to-run-the-examples/"/><link rel="canonical" href="https://cesmix-mit.github.io/PotentialLearning.jl/how-to-run-the-examples/"/><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="../">PotentialLearning.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><a class="tocitem" href="../">Home</a></li><li class="is-active"><a class="tocitem" href>How to run the examples</a><ul class="internal"><li><a class="tocitem" href="#Add-registries"><span>Add registries</span></a></li><li><a class="tocitem" href="#Install-the-dependencies-of-the-examples-folder-project"><span>Install the dependencies of the <code>examples</code> folder project</span></a></li><li><a class="tocitem" href="#Run-an-example"><span>Run an example</span></a></li></ul></li><li><a class="tocitem" href="../api/">API</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>How to run the examples</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>How to run the examples</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/cesmix-mit/PotentialLearning.jl/blob/main/docs/src/how-to-run-the-examples.md#" title="Edit 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="How-to-run-the-examples"><a class="docs-heading-anchor" href="#How-to-run-the-examples">How to run the examples</a><a id="How-to-run-the-examples-1"></a><a class="docs-heading-anchor-permalink" href="#How-to-run-the-examples" title="Permalink"></a></h1><h2 id="Add-registries"><a class="docs-heading-anchor" href="#Add-registries">Add registries</a><a id="Add-registries-1"></a><a class="docs-heading-anchor-permalink" href="#Add-registries" title="Permalink"></a></h2><p>Open a Julia REPL (<code>$ julia</code>), type <code>]</code> to enter the Pkg REPL, and add the following registries:</p><pre><code class="language-julia hljs"> pkg&gt; registry add https://github.com/JuliaRegistries/General
pkg&gt; registry add https://github.com/cesmix-mit/CESMIX.git
pkg&gt; registry add https://github.com/JuliaMolSim/MolSim.git
pkg&gt; registry add https://github.com/ACEsuit/ACEregistry</code></pre><h2 id="Install-the-dependencies-of-the-examples-folder-project"><a class="docs-heading-anchor" href="#Install-the-dependencies-of-the-examples-folder-project">Install the dependencies of the <code>examples</code> folder project</a><a id="Install-the-dependencies-of-the-examples-folder-project-1"></a><a class="docs-heading-anchor-permalink" href="#Install-the-dependencies-of-the-examples-folder-project" title="Permalink"></a></h2><p>Clone <code>PotentialLearning.jl</code> repository in your working directory.</p><pre><code class="language-shell hljs"> $ git clone [email protected]:cesmix-mit/PotentialLearning.jl.git</code></pre><p>Open a Julia REPL activating the <code>examples</code> folder project.</p><pre><code class="language-shell hljs"> $ julia --project=PotentialLearning.jl/examples</code></pre><p>Type <code>]</code> to enter the Pkg REPL and instantiate.</p><pre><code class="language-julia hljs"> pkg&gt; instantiate</code></pre><h2 id="Run-an-example"><a class="docs-heading-anchor" href="#Run-an-example">Run an example</a><a id="Run-an-example-1"></a><a class="docs-heading-anchor-permalink" href="#Run-an-example" title="Permalink"></a></h2><p>Access to any folder within <code>PotentialLearning.jl/examples</code>. E.g.</p><pre><code class="language-shell hljs"> $ cd PotentialLearning.jl/examples/ACE</code></pre><p>Open a Julia REPL, activate the <code>examples</code> folder project, and define the number of threads.</p><pre><code class="language-julia hljs"> $ julia --project=../ --threads=4</code></pre><p>Finally, include the example file.</p><pre><code class="language-julia hljs"> julia&gt; include(&quot;fit-ace.jl&quot;)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../api/">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="auto">Automatic (OS)</option><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 1.4.1 on <span class="colophon-date" title="Wednesday 5 June 2024 15:39">Wednesday 5 June 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
pkg&gt; registry add https://github.com/ACEsuit/ACEregistry</code></pre><h2 id="Install-the-dependencies-of-the-examples-folder-project"><a class="docs-heading-anchor" href="#Install-the-dependencies-of-the-examples-folder-project">Install the dependencies of the <code>examples</code> folder project</a><a id="Install-the-dependencies-of-the-examples-folder-project-1"></a><a class="docs-heading-anchor-permalink" href="#Install-the-dependencies-of-the-examples-folder-project" title="Permalink"></a></h2><p>Clone <code>PotentialLearning.jl</code> repository in your working directory.</p><pre><code class="language-shell hljs"> $ git clone [email protected]:cesmix-mit/PotentialLearning.jl.git</code></pre><p>Open a Julia REPL activating the <code>examples</code> folder project.</p><pre><code class="language-shell hljs"> $ julia --project=PotentialLearning.jl/examples</code></pre><p>Type <code>]</code> to enter the Pkg REPL and instantiate.</p><pre><code class="language-julia hljs"> pkg&gt; instantiate</code></pre><h2 id="Run-an-example"><a class="docs-heading-anchor" href="#Run-an-example">Run an example</a><a id="Run-an-example-1"></a><a class="docs-heading-anchor-permalink" href="#Run-an-example" title="Permalink"></a></h2><p>Access to any folder within <code>PotentialLearning.jl/examples</code>. E.g.</p><pre><code class="language-shell hljs"> $ cd PotentialLearning.jl/examples/ACE</code></pre><p>Open a Julia REPL, activate the <code>examples</code> folder project, and define the number of threads.</p><pre><code class="language-julia hljs"> $ julia --project=../ --threads=4</code></pre><p>Finally, include the example file.</p><pre><code class="language-julia hljs"> julia&gt; include(&quot;fit-ace.jl&quot;)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../api/">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="auto">Automatic (OS)</option><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 1.4.1 on <span class="colophon-date" title="Wednesday 5 June 2024 15:41">Wednesday 5 June 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit c105910

Please sign in to comment.