Skip to content

Commit

Permalink
build based on 3ce902a
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Jan 31, 2024
1 parent 388b3c4 commit 8d6b92d
Show file tree
Hide file tree
Showing 9 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion latest/.documenter-siteinfo.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.0","generation_timestamp":"2024-01-29T05:16:40","documenter_version":"1.2.1"}}
{"documenter":{"julia_version":"1.10.0","generation_timestamp":"2024-01-31T05:51:44","documenter_version":"1.2.1"}}
2 changes: 1 addition & 1 deletion latest/algorithm/index.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions latest/apidocs/index.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions latest/examples/index.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions latest/index.html

Large diffs are not rendered by default.

Binary file modified latest/md_nlcd_omniscape_output/cum_currmap.tif
Binary file not shown.
Binary file modified latest/md_nlcd_omniscape_output/flow_potential.tif
Binary file not shown.
Binary file modified latest/md_nlcd_omniscape_output/normalized_cum_currmap.tif
Binary file not shown.
4 changes: 2 additions & 2 deletions latest/usage/index.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>User Guide · Omniscape.jl</title><meta name="title" content="User Guide · Omniscape.jl"/><meta property="og:title" content="User Guide · Omniscape.jl"/><meta property="twitter:title" content="User Guide · Omniscape.jl"/><meta name="description" content="Documentation for Omniscape.jl."/><meta property="og:description" content="Documentation for Omniscape.jl."/><meta property="twitter:description" content="Documentation for Omniscape.jl."/><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><link href="../assets/custom.css" rel="stylesheet" type="text/css"/></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../"><img src="../assets/logo.png" alt="Omniscape.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../">Omniscape.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="../">About</a></li><li><a class="tocitem" href="../algorithm/">How It Works</a></li><li class="is-active"><a class="tocitem" href>User Guide</a><ul class="internal"><li><a class="tocitem" href="#Installation"><span>Installation</span></a></li><li><a class="tocitem" href="#Running-Omniscape"><span>Running Omniscape</span></a></li><li><a class="tocitem" href="#Settings-and-Options"><span>Settings and Options</span></a></li><li><a class="tocitem" href="#Omniscape-in-Docker"><span>Omniscape in Docker</span></a></li></ul></li><li><a class="tocitem" href="../examples/">Examples</a></li><li><a class="tocitem" href="../apidocs/">API Documentation</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>User Guide</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>User Guide</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/Circuitscape/Omniscape.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/Circuitscape/Omniscape.jl/blob/b7093fb5c0a8edda5b8eb1279a108a408a3d9c9d/docs/src/usage.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="User-Guide"><a class="docs-heading-anchor" href="#User-Guide">User Guide</a><a id="User-Guide-1"></a><a class="docs-heading-anchor-permalink" href="#User-Guide" title="Permalink"></a></h1><h2 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></h2><p>The latest version of Omniscape.jl <strong>requires Julia version 1.5.4 or greater</strong>. You can install Julia <a href="https://julialang.org/downloads/">here</a>. Once installation is complete, open a Julia terminal and run the following code to install Omniscape.jl.</p><pre><code class="language-julia hljs">using Pkg; Pkg.add(&quot;Omniscape&quot;)</code></pre><p>If you want to install the latest (unreleased) development version of Omniscape.jl, you can get it by running:</p><pre><code class="language-julia hljs">using Pkg; Pkg.add(PackageSpec(name = &quot;Omniscape&quot;, rev = &quot;main&quot;))</code></pre><p>Don&#39;t forget to &quot;watch&quot; the Omniscape.jl repository on GitHub to be notified of new releases! </p><td>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>User Guide · Omniscape.jl</title><meta name="title" content="User Guide · Omniscape.jl"/><meta property="og:title" content="User Guide · Omniscape.jl"/><meta property="twitter:title" content="User Guide · Omniscape.jl"/><meta name="description" content="Documentation for Omniscape.jl."/><meta property="og:description" content="Documentation for Omniscape.jl."/><meta property="twitter:description" content="Documentation for Omniscape.jl."/><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><link href="../assets/custom.css" rel="stylesheet" type="text/css"/></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../"><img src="../assets/logo.png" alt="Omniscape.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../">Omniscape.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="../">About</a></li><li><a class="tocitem" href="../algorithm/">How It Works</a></li><li class="is-active"><a class="tocitem" href>User Guide</a><ul class="internal"><li><a class="tocitem" href="#Installation"><span>Installation</span></a></li><li><a class="tocitem" href="#Running-Omniscape"><span>Running Omniscape</span></a></li><li><a class="tocitem" href="#Settings-and-Options"><span>Settings and Options</span></a></li><li><a class="tocitem" href="#Omniscape-in-Docker"><span>Omniscape in Docker</span></a></li></ul></li><li><a class="tocitem" href="../examples/">Examples</a></li><li><a class="tocitem" href="../apidocs/">API Documentation</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>User Guide</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>User Guide</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/Circuitscape/Omniscape.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/Circuitscape/Omniscape.jl/blob/3ce902a9346e8594bdc4cd388fa2684fcd4eaf98/docs/src/usage.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="User-Guide"><a class="docs-heading-anchor" href="#User-Guide">User Guide</a><a id="User-Guide-1"></a><a class="docs-heading-anchor-permalink" href="#User-Guide" title="Permalink"></a></h1><h2 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></h2><p>The latest version of Omniscape.jl <strong>requires Julia version 1.5.4 or greater</strong>. You can install Julia <a href="https://julialang.org/downloads/">here</a>. Once installation is complete, open a Julia terminal and run the following code to install Omniscape.jl.</p><pre><code class="language-julia hljs">using Pkg; Pkg.add(&quot;Omniscape&quot;)</code></pre><p>If you want to install the latest (unreleased) development version of Omniscape.jl, you can get it by running:</p><pre><code class="language-julia hljs">using Pkg; Pkg.add(PackageSpec(name = &quot;Omniscape&quot;, rev = &quot;main&quot;))</code></pre><p>Don&#39;t forget to &quot;watch&quot; the Omniscape.jl repository on GitHub to be notified of new releases! </p><td>
<figure>
<img src='../figs/watch_releases.gif' alt='How to be notified of new releases'><br>
<figcaption><em></em></figcaption>
Expand Down Expand Up @@ -46,4 +46,4 @@
-v %cd%:/home/omniscape^
-w /home/omniscape^
-e JULIA_NUM_THREADS=2^
vlandau/omniscape:latest</code></pre><p>The <code>-v</code> flag and subsequent code will mount the files in your current working directory and make them available to the Docker container (which is why you need to run the code above from the directory that contains your input files). Once you&#39;re in Julia in the Docker container, you&#39;re ready to go! Make sure that the file paths in your .ini file are relative to the working directory from which you ran Docker.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../algorithm/">« How It Works</a><a class="docs-footer-nextpage" href="../examples/">Examples »</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="Monday 29 January 2024 05:16">Monday 29 January 2024</span>. Using Julia version 1.10.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
vlandau/omniscape:latest</code></pre><p>The <code>-v</code> flag and subsequent code will mount the files in your current working directory and make them available to the Docker container (which is why you need to run the code above from the directory that contains your input files). Once you&#39;re in Julia in the Docker container, you&#39;re ready to go! Make sure that the file paths in your .ini file are relative to the working directory from which you ran Docker.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../algorithm/">« How It Works</a><a class="docs-footer-nextpage" href="../examples/">Examples »</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="Wednesday 31 January 2024 05:51">Wednesday 31 January 2024</span>. Using Julia version 1.10.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 comments on commit 8d6b92d

Please sign in to comment.