Skip to content

Commit

Permalink
build based on a4a5895
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Mar 27, 2024
1 parent ec35a48 commit 6243cce
Show file tree
Hide file tree
Showing 11 changed files with 44 additions and 44 deletions.
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>Getting Started · Scruff.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>Scruff.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>Getting Started</a><ul class="internal"><li><a class="tocitem" href="#Installation"><span>Installation</span></a></li><li><a class="tocitem" href="#Developing-Scruff"><span>Developing Scruff</span></a></li><li><a class="tocitem" href="#Learning-about-Scruff"><span>Learning about Scruff</span></a></li><li><a class="tocitem" href="#Contributing-to-Scruff"><span>Contributing to Scruff</span></a></li></ul></li><li><a class="tocitem" href="tutorial/tutorial/">Tutorial</a></li><li><a class="tocitem" href="tutorial/examples/">Examples</a></li><li><span class="tocitem">Library</span><ul><li><a class="tocitem" href="lib/core/">Core</a></li><li><a class="tocitem" href="lib/sfuncs/">Stochastic Functions</a></li><li><a class="tocitem" href="lib/operators/">Operators</a></li><li><a class="tocitem" href="lib/models/">Models</a></li><li><a class="tocitem" href="lib/algorithms/">Algorithms</a></li><li><a class="tocitem" href="lib/utilities/">Utilities</a></li><li><a class="tocitem" href="lib/rtutils/">Runtime Utilities</a></li></ul></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>Getting Started</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Getting Started</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/charles-river-analytics/Scruff.jl/blob/develop/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="Scruff"><a class="docs-heading-anchor" href="#Scruff">Scruff</a><a id="Scruff-1"></a><a class="docs-heading-anchor-permalink" href="#Scruff" title="Permalink"></a></h1><p>Scruff is an AI framework to build agents that sense, reason, and learn in the world using a variety of models. It aims to integrate many different kinds of models in a coherent framework, provide flexibility in spatiotemporal modeling, and provide tools to compose, share, and reuse models and model components.</p><p>Warning: Scruff is rapidly evolving beta research software. Although the software already has a lot of functionality, we intend to expand on this in the future and cannot promise stability of the code or the APIs at the moment.</p><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>First, <a href="https://julialang.org/downloads/">download Julia 1.6.0 or later</a>.</p><p>Then, install the Scruff package with the Julia package manager. From the Julia REPL, type <code>]</code> to enter the Pkg REPL mode and then run:</p><pre><code class="language-julia-repl hljs">pkg&gt; add Scruff</code></pre><h2 id="Developing-Scruff"><a class="docs-heading-anchor" href="#Developing-Scruff">Developing Scruff</a><a id="Developing-Scruff-1"></a><a class="docs-heading-anchor-permalink" href="#Developing-Scruff" title="Permalink"></a></h2><p>To develop Scruff, first pull down the code</p><pre><code class="language-bash hljs">$ git clone https://github.com/p2t2/Scruff.git</code></pre><h2 id="Learning-about-Scruff"><a class="docs-heading-anchor" href="#Learning-about-Scruff">Learning about Scruff</a><a id="Learning-about-Scruff-1"></a><a class="docs-heading-anchor-permalink" href="#Learning-about-Scruff" title="Permalink"></a></h2><p>Please read the <a href="tutorial/tutorial/#The-Scruff-Tutorial">The Scruff Tutorial</a>, which describes most of the language features through examples. The library documentation contains detailed information about most of the data structures and functions used in the code.</p><h2 id="Contributing-to-Scruff"><a class="docs-heading-anchor" href="#Contributing-to-Scruff">Contributing to Scruff</a><a id="Contributing-to-Scruff-1"></a><a class="docs-heading-anchor-permalink" href="#Contributing-to-Scruff" title="Permalink"></a></h2><p>We welcome contributions from the community. Please see the issues in Github for some of the improvements we would like to make, and feel free to add your own suggestions. </p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="tutorial/tutorial/">Tutorial »</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="Wednesday 27 March 2024 16:21">Wednesday 27 March 2024</span>. Using Julia version 1.7.3.</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>Getting Started · Scruff.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>Scruff.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>Getting Started</a><ul class="internal"><li><a class="tocitem" href="#Installation"><span>Installation</span></a></li><li><a class="tocitem" href="#Developing-Scruff"><span>Developing Scruff</span></a></li><li><a class="tocitem" href="#Learning-about-Scruff"><span>Learning about Scruff</span></a></li><li><a class="tocitem" href="#Contributing-to-Scruff"><span>Contributing to Scruff</span></a></li></ul></li><li><a class="tocitem" href="tutorial/tutorial/">Tutorial</a></li><li><a class="tocitem" href="tutorial/examples/">Examples</a></li><li><span class="tocitem">Library</span><ul><li><a class="tocitem" href="lib/core/">Core</a></li><li><a class="tocitem" href="lib/sfuncs/">Stochastic Functions</a></li><li><a class="tocitem" href="lib/operators/">Operators</a></li><li><a class="tocitem" href="lib/models/">Models</a></li><li><a class="tocitem" href="lib/algorithms/">Algorithms</a></li><li><a class="tocitem" href="lib/utilities/">Utilities</a></li><li><a class="tocitem" href="lib/rtutils/">Runtime Utilities</a></li></ul></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>Getting Started</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Getting Started</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/charles-river-analytics/Scruff.jl/blob/develop/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="Scruff"><a class="docs-heading-anchor" href="#Scruff">Scruff</a><a id="Scruff-1"></a><a class="docs-heading-anchor-permalink" href="#Scruff" title="Permalink"></a></h1><p>Scruff is an AI framework to build agents that sense, reason, and learn in the world using a variety of models. It aims to integrate many different kinds of models in a coherent framework, provide flexibility in spatiotemporal modeling, and provide tools to compose, share, and reuse models and model components.</p><p>Warning: Scruff is rapidly evolving beta research software. Although the software already has a lot of functionality, we intend to expand on this in the future and cannot promise stability of the code or the APIs at the moment.</p><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>First, <a href="https://julialang.org/downloads/">download Julia 1.6.0 or later</a>.</p><p>Then, install the Scruff package with the Julia package manager. From the Julia REPL, type <code>]</code> to enter the Pkg REPL mode and then run:</p><pre><code class="language-julia-repl hljs">pkg&gt; add Scruff</code></pre><h2 id="Developing-Scruff"><a class="docs-heading-anchor" href="#Developing-Scruff">Developing Scruff</a><a id="Developing-Scruff-1"></a><a class="docs-heading-anchor-permalink" href="#Developing-Scruff" title="Permalink"></a></h2><p>To develop Scruff, first pull down the code</p><pre><code class="language-bash hljs">$ git clone https://github.com/p2t2/Scruff.git</code></pre><h2 id="Learning-about-Scruff"><a class="docs-heading-anchor" href="#Learning-about-Scruff">Learning about Scruff</a><a id="Learning-about-Scruff-1"></a><a class="docs-heading-anchor-permalink" href="#Learning-about-Scruff" title="Permalink"></a></h2><p>Please read the <a href="tutorial/tutorial/#The-Scruff-Tutorial">The Scruff Tutorial</a>, which describes most of the language features through examples. The library documentation contains detailed information about most of the data structures and functions used in the code.</p><h2 id="Contributing-to-Scruff"><a class="docs-heading-anchor" href="#Contributing-to-Scruff">Contributing to Scruff</a><a id="Contributing-to-Scruff-1"></a><a class="docs-heading-anchor-permalink" href="#Contributing-to-Scruff" title="Permalink"></a></h2><p>We welcome contributions from the community. Please see the issues in Github for some of the improvements we would like to make, and feel free to add your own suggestions. </p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="tutorial/tutorial/">Tutorial »</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="Wednesday 27 March 2024 17:40">Wednesday 27 March 2024</span>. Using Julia version 1.7.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 6243cce

Please sign in to comment.