deploy: 8fd75e3

NREL · Feb 26, 2024 · 82e10ba · 82e10ba
1 parent 9f6f3c2
commit 82e10ba
Show file tree

Hide file tree

Showing 10 changed files with 124 additions and 76 deletions.
diff --git a/_sources/installation.md b/_sources/installation.md
@@ -0,0 +1,40 @@
+# Installation
+
+moa_python is currently not available as a package on any repository manager.
+Instead, it must be installed by the user by cloning the GitHub repository.
+
+To download the source code, use `git clone`. Then, add it to
+your Python path with the "local editable install" through `pip`.
+
+```bash
+# Download the source code.
+git clone https://github.com/NREL/moa_python.git
+
+# Install into your Python environment
+pip install -e moa_python
+
+```
+
+If installing moa_python with the intention to develop, some additional configuration is helpful:
+
+
+Install moa_python in editable mode with the appropriate developer tools
+
+   - ``".[develop]"`` is for the linting and code checking tools
+   - ``".[docs]"`` is for the documentation building tools. Ideally, developers should also be
+     contributing to the documentation, and therefore checking that
+     the documentation builds locally.
+
+```bash
+pip install -e ".[develop, docs]"
+```
+Turn on the linting and code checking tools
+
+```bash
+pre-commit install
+```
+
+If everything is configured correctly, any changes made to the source
+code will be available directly through your local Python. Remember
+to re-import the FLASC module when changes are made if you are working
+in an interactive environment like Jupyter.
diff --git a/_sources/intro.md b/_sources/intro.md
@@ -1,5 +1,6 @@
 # moa_python
 
-MOA Python
+MOA Python is a companion tool for Hercules (www.github.com/NREL/hercules) and is designed to facilitate the analysis of large datasets.  
+
+
 
-Small edit
diff --git a/_sources/kestrel_tunneling.md b/_sources/kestrel_tunneling.md
@@ -1,4 +1,4 @@
-# README.md
+# Kestrel Tunneling
 
 This subfolder demonstrates how to implement tunneling for jupyter notebooks into NREL's HPC system kestrel
 

diff --git a/genindex.html b/genindex.html
@@ -144,14 +144,14 @@
 
                     <li class="nav-item">
                       <a class="nav-link nav-internal" href="installation.html">
-                        <no title>
+                        Installation
                       </a>
                     </li>
 
 
                     <li class="nav-item">
                       <a class="nav-link nav-internal" href="kestrel_tunneling.html">
-                        README.md
+                        Kestrel Tunneling
                       </a>
                     </li>
 
@@ -223,14 +223,14 @@
 
                     <li class="nav-item">
                       <a class="nav-link nav-internal" href="installation.html">
-                        <no title>
+                        Installation
                       </a>
                     </li>
 
 
                     <li class="nav-item">
                       <a class="nav-link nav-internal" href="kestrel_tunneling.html">
-                        README.md
+                        Kestrel Tunneling
                       </a>
                     </li>
 
@@ -304,7 +304,8 @@
         </ul>
         <p aria-level="2" class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
 <ul class="nav bd-sidenav">
-<li class="toctree-l1"><a class="reference internal" href="kestrel_tunneling.html">README.md</a></li>
+<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="kestrel_tunneling.html">Kestrel Tunneling</a></li>
 </ul>
 
     </div>

diff --git a/installation.html b/installation.html
@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
-    <title>&lt;no title&gt; &#8212; MOA_PYTHON</title>
+    <title>Installation &#8212; MOA_PYTHON</title>
 
 
 
@@ -68,7 +68,7 @@
     <script>DOCUMENTATION_OPTIONS.pagename = 'installation';</script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="README.md" href="kestrel_tunneling.html" />
+    <link rel="next" title="Kestrel Tunneling" href="kestrel_tunneling.html" />
     <link rel="prev" title="moa_python" href="intro.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1" />
   <meta name="docsearch:language" content="python">
@@ -145,14 +145,14 @@
 
                     <li class="nav-item current active">
                       <a class="nav-link nav-internal" href="#">
-                        <no title>
+                        Installation
                       </a>
                     </li>
 
 
                     <li class="nav-item">
                       <a class="nav-link nav-internal" href="kestrel_tunneling.html">
-                        README.md
+                        Kestrel Tunneling
                       </a>
                     </li>
 
@@ -199,10 +199,6 @@
 
 
 
-  <label class="sidebar-toggle secondary-toggle" for="__secondary">
-      <span class="fa-solid fa-outdent"></span>
-  </label>
-
 
 </div>
   </nav>
@@ -228,14 +224,14 @@
 
                     <li class="nav-item current active">
                       <a class="nav-link nav-internal" href="#">
-                        <no title>
+                        Installation
                       </a>
                     </li>
 
 
                     <li class="nav-item">
                       <a class="nav-link nav-internal" href="kestrel_tunneling.html">
-                        README.md
+                        Kestrel Tunneling
                       </a>
                     </li>
 
@@ -308,8 +304,9 @@
             </li>
         </ul>
         <p aria-level="2" class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
-<ul class="nav bd-sidenav">
-<li class="toctree-l1"><a class="reference internal" href="kestrel_tunneling.html">README.md</a></li>
+<ul class="current nav bd-sidenav">
+<li class="toctree-l1 current active"><a class="current reference internal" href="#">Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="kestrel_tunneling.html">Kestrel Tunneling</a></li>
 </ul>
 
     </div>
@@ -458,36 +455,59 @@
 
   </ul>
 </div>
-<label class="sidebar-toggle secondary-toggle btn btn-sm" for="__secondary" data-toggle="tooltip" data-placement="left" title="Toggle secondary sidebar">
-            <span class="fa-solid fa-list"></span>
-        </label>
+
     </div>
 </div>
             </div>
 
 
 
 <div id="jb-print-docs-body" class="onlyprint">
-    <h1><no title></h1>
+    <h1>Installation</h1>
     <!-- Table of contents -->
     <div id="print-main-content">
         <div id="jb-print-toc">
 
-            <div>
-                <h2> Contents </h2>
-            </div>
-            <nav aria-label="Page">
-                <ul class="simple visible nav section-nav flex-column">
-</ul>
-
-            </nav>
         </div>
     </div>
 </div>
 
             <article class="bd-article" role="main">
 
-
+  <section class="tex2jax_ignore mathjax_ignore" id="installation">
+<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this heading">#</a></h1>
+<p>moa_python is currently not available as a package on any repository manager.
+Instead, it must be installed by the user by cloning the GitHub repository.</p>
+<p>To download the source code, use <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">clone</span></code>. Then, add it to
+your Python path with the &quot;local editable install&quot; through <code class="docutils literal notranslate"><span class="pre">pip</span></code>.</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># Download the source code.</span>
+git<span class="w"> </span>clone<span class="w"> </span>https://github.com/NREL/moa_python.git
+
+<span class="c1"># Install into your Python environment</span>
+pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span>moa_python
+</pre></div>
+</div>
+<p>If installing moa_python with the intention to develop, some additional configuration is helpful:</p>
+<p>Install moa_python in editable mode with the appropriate developer tools</p>
+<ul class="simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">&quot;.[develop]&quot;</span></code> is for the linting and code checking tools</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">&quot;.[docs]&quot;</span></code> is for the documentation building tools. Ideally, developers should also be
+contributing to the documentation, and therefore checking that
+the documentation builds locally.</p></li>
+</ul>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span><span class="s2">&quot;.[develop, docs]&quot;</span>
+</pre></div>
+</div>
+<p>Turn on the linting and code checking tools</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pre-commit<span class="w"> </span>install
+</pre></div>
+</div>
+<p>If everything is configured correctly, any changes made to the source
+code will be available directly through your local Python. Remember
+to re-import the FLASC module when changes are made if you are working
+in an interactive environment like Jupyter.</p>
+</section>
+
     <script type="text/x-thebe-config">
     {
         requestKernel: true,
@@ -526,7 +546,7 @@ <h2> Contents </h2>
   <a class='right-next' id="next-link" href="kestrel_tunneling.html" title="next page">
   <div class="prev-next-info">
       <p class="prev-next-subtitle">next</p>
-      <p class="prev-next-title">README.md</p>
+      <p class="prev-next-title">Kestrel Tunneling</p>
   </div>
   <i class="fa-solid fa-angle-right"></i>
   </a>
@@ -537,22 +557,6 @@ <h2> Contents </h2>
 
 
 
-            <div class="bd-sidebar-secondary bd-toc">
-
-<div class="toc-item">
-
-<div class="tocsection onthispage">
-    <i class="fa-solid fa-list"></i> On this page
-</div>
-<nav id="bd-toc-nav" class="page-toc">
-    <ul class="simple visible nav section-nav flex-column">
-</ul>
-
-</nav>
-</div>
-
-            </div>
-
 
         </div>
         <footer class="bd-footer-content">

diff --git a/intro.html b/intro.html
@@ -68,7 +68,7 @@
     <script>DOCUMENTATION_OPTIONS.pagename = 'intro';</script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="&lt;no title&gt;" href="installation.html" />
+    <link rel="next" title="Installation" href="installation.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1" />
   <meta name="docsearch:language" content="python">
   </head>
@@ -144,14 +144,14 @@
 
                     <li class="nav-item">
                       <a class="nav-link nav-internal" href="installation.html">
-                        <no title>
+                        Installation
                       </a>
                     </li>
 
 
                     <li class="nav-item">
                       <a class="nav-link nav-internal" href="kestrel_tunneling.html">
-                        README.md
+                        Kestrel Tunneling
                       </a>
                     </li>
 
@@ -223,14 +223,14 @@
 
                     <li class="nav-item">
                       <a class="nav-link nav-internal" href="installation.html">
-                        <no title>
+                        Installation
                       </a>
                     </li>
 
 
                     <li class="nav-item">
                       <a class="nav-link nav-internal" href="kestrel_tunneling.html">
-                        README.md
+                        Kestrel Tunneling
                       </a>
                     </li>
 
@@ -304,7 +304,8 @@
         </ul>
         <p aria-level="2" class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
 <ul class="nav bd-sidenav">
-<li class="toctree-l1"><a class="reference internal" href="kestrel_tunneling.html">README.md</a></li>
+<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="kestrel_tunneling.html">Kestrel Tunneling</a></li>
 </ul>
 
     </div>
@@ -474,8 +475,7 @@ <h1>moa_python</h1>
 
   <section class="tex2jax_ignore mathjax_ignore" id="moa-python">
 <h1>moa_python<a class="headerlink" href="#moa-python" title="Permalink to this heading">#</a></h1>
-<p>MOA Python</p>
-<p>Small edit</p>
+<p>MOA Python is a companion tool for Hercules (<a class="reference external" href="http://www.github.com/NREL/hercules">www.github.com/NREL/hercules</a>) and is designed to facilitate the analysis of large datasets.</p>
 <div class="toctree-wrapper compound">
 </div>
 </section>
@@ -511,7 +511,7 @@ <h1>moa_python<a class="headerlink" href="#moa-python" title="Permalink to this
   <a class='right-next' id="next-link" href="installation.html" title="next page">
   <div class="prev-next-info">
       <p class="prev-next-subtitle">next</p>
-      <p class="prev-next-title">&lt;no title&gt;</p>
+      <p class="prev-next-title">Installation</p>
   </div>
   <i class="fa-solid fa-angle-right"></i>
   </a>