Updating documentation

mdp0023 · Apr 15, 2024 · 435e03d · 435e03d
1 parent 2f30a8b
commit 435e03d
Show file tree

Hide file tree

Showing 74 changed files with 4,264 additions and 1,070 deletions.
diff --git a/doc/.DS_Store b/doc/.DS_Store
diff --git a/doc/Acknowledgements/acknowledgements.rst b/doc/Acknowledgements/acknowledgements.rst
@@ -0,0 +1,4 @@
+Acknowledgements
+================
+
+Funding sources and lab information goes here.
diff --git a/doc/Background/background.rst b/doc/Background/background.rst
diff --git a/doc/Background/variables.csv b/doc/Background/variables.csv
@@ -0,0 +1,30 @@
+.. centered:: Variable Name,.. centered:: Variable Definition,.. centered:: ACS5 Source Data
+QAGDDEP,Percent of population under the age of 5 or over the age of 65,"['B01001_001E', 'B01001_026E', 'B01001_003E', 'B01001_020E', 'B01001_021E', 'B01001_022E', 'B01001_023E', 'B01001_024E', 'B01001_025E', 'B01001_027E', 'B01001_044E', 'B01001_045E', 'B01001_046E', 'B01001_047E', 'B01001_048E', 'B01001_049E']"
+QFEMALE,Percent of population that is female,"['B01001_001E', 'B01001_026E']"
+MEDAGE,Median age,['B01002_001E']
+QBLACK,Percent of population that is non-Hispanic Black/African-American,"['B03002_001E', 'B03002_004E']"
+QNATIVE,Percent of population that is non-Hispanic Native American,"['B03002_001E', 'B03002_005E']"
+QASIAN,Percent of population that is non-Hispanic Asian,"['B03002_001E', 'B03002_006E']"
+QHISPC,Percent of population that is Hispanic,"['B03002_001E', 'B03002_012E']"
+QFAM,Percent of families where only one spouse is present in the household,"['B11005_003E', 'B11005_005E']"
+PPUNIT,"People per unit, or average household size",['B25010_001E']
+QFHH,Percent of households with Female householder and no spouse present,"['B11001_001E', 'B11001_006E']"
+QEDLESHI,Percent of population over the age of 25 with less than a high school diploma (or equivalent),"['B15003_001E', 'B15003_002E', 'B15003_003E', 'B15003_004E', 'B15003_005E', 'B15003_006E', 'B15003_007E', 'B15003_008E', 'B15003_009E', 'B15003_010E', 'B15003_011E', 'B15003_012E', 'B15003_013E', 'B15003_014E', 'B15003_015E', 'B15003_016E']"
+QCVLUN,Percent of civilian population over the age of 15 that is unemployed,"['B23025_003E', 'B23025_005E']"
+QRICH,"Percent of households earning over $200,000 annually (inversely related to vulnerability)","['B19001_001E', 'B19001_017E']"
+QSSBEN,Percent of houseolds with social security income,"['B19055_001E', 'B19055_002E']"
+PERCAP,Per capita income in the past 12 months (inversely related to vulnerability),['B19301_001E']
+QRENTER,Percent of households that are renters,"['B25003_001E', 'B25003_003E']"
+QUNOCCHU,Percent of housing units that are unoccupied,"['B25002_001E', 'B25002_003E']"
+QMOHO,Percent of housing unts that are mobile homes,"['B25024_001E', 'B25024_010E']"
+MDHSEVAL,Median housing value (inversely related to vulnerability),['B25077_001E']
+MDGRENT,Median gross rent,['B25064_001E']
+QPOVTY,Percent of population whose income in the past 12 months was below the poverty level,"['B17021_001E', 'B17021_002E']"
+QNOAUTO,Percent of households without access to a car,"['B25044_001E', 'B25044_003E', 'B25044_010E']"
+QNOHLTH,Percent of population without health insurance,"['B27001_001E', 'B27001_005E', 'B27001_008E', 'B27001_011E', 'B27001_014E', 'B27001_017E', 'B27001_020E', 'B27001_023E', 'B27001_026E', 'B27001_029E', 'B27001_033E', 'B27001_036E', 'B27001_039E', 'B27001_042E', 'B27001_045E', 'B27001_048E', 'B27001_051E', 'B27001_054E', 'B27001_057E']"
+QESL,"Percent of population who speaks English ""not well"" or ""not at all"" ","['B16004_001E', 'B16004_007E', 'B16004_008E', 'B16004_012E', 'B16004_013E', 'B16004_017E', 'B16004_018E', 'B16004_022E', 'B16004_023E', 'B16004_029E', 'B16004_030E', 'B16004_034E', 'B16004_035E', 'B16004_039E', 'B16004_040E', 'B16004_044E', 'B16004_045E', 'B16004_051E', 'B16004_052E', 'B16004_056E', 'B16004_057E', 'B16004_061E', 'B16004_062E', 'B16004_066E', 'B16004_067E'],"
+QFEMLBR,Percent of the civilian employed population over the age of 16 that is female,"['C24010_001E', 'C24010_038E']"
+QSERV,Percent of the civilian employed population that has a service occupation,"['C24010_001E', 'C24010_019E', 'C24010_055E']"
+QEXTRCT,Percent of the civilian employed population that has a construction and extraction occupation,"['C24010_001E', 'C24010_032E', 'C24010_068E']"
+,,
+,,
diff --git a/doc/Getting_Started/quickstart.rst b/doc/Getting_Started/quickstart.rst
@@ -10,7 +10,7 @@ First we load the SVInsight package, set the necessary variables, and create the
 
 .. doctest::
 
-    >>> import SVInsight as svi
+    >>> from SVInsight import SVInsight as svi
     >>> project_name = 'Travis_County_SVI'
     >>> file_path = "YOUR PARENT FOLDER HERE"
     >>> api_key = 'YOUR CENSUS API KEY HERE'

diff --git a/doc/_build/doctrees/Acknowledgements/acknowledgements.doctree b/doc/_build/doctrees/Acknowledgements/acknowledgements.doctree
diff --git a/doc/_build/doctrees/Background/background.doctree b/doc/_build/doctrees/Background/background.doctree
diff --git a/doc/_build/doctrees/Background/paper.doctree b/doc/_build/doctrees/Background/paper.doctree
diff --git a/doc/_build/doctrees/Examples/examples.doctree b/doc/_build/doctrees/Examples/examples.doctree
diff --git a/doc/_build/doctrees/Getting_Started/install.doctree b/doc/_build/doctrees/Getting_Started/install.doctree
diff --git a/doc/_build/doctrees/Getting_Started/quickstart.doctree b/doc/_build/doctrees/Getting_Started/quickstart.doctree
diff --git a/doc/_build/doctrees/User_Guide/userguide.doctree b/doc/_build/doctrees/User_Guide/userguide.doctree
diff --git a/doc/_build/doctrees/environment.pickle b/doc/_build/doctrees/environment.pickle
diff --git a/doc/_build/doctrees/index.doctree b/doc/_build/doctrees/index.doctree
diff --git a/doc/_build/html/.DS_Store b/doc/_build/html/.DS_Store
diff --git a/doc/_build/html/.buildinfo b/doc/_build/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 93d050e43e4420be59d67d3b049d7eac
+config: 5e36d830a20bb64b0437a829a681f024
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/doc/_build/html/Acknowledgements/acknowledgements.html b/doc/_build/html/Acknowledgements/acknowledgements.html
@@ -0,0 +1,258 @@
+<!doctype html>
+<html class="no-js" lang="en" data-content_root="../">
+  <head><meta charset="utf-8"/>
+    <meta name="viewport" content="width=device-width,initial-scale=1"/>
+    <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
+<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="prev" title="Examples" href="../Examples/examples.html" />
+
+    <!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 -->
+        <title>Acknowledgements - SVInsight documentation</title>
+      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=362ab14a" />
+    <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=135e06be" />
+    <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" />
+
+
+
+
+<style>
+  body {
+    --color-code-background: #f8f8f8;
+  --color-code-foreground: black;
+
+  }
+  @media not print {
+    body[data-theme="dark"] {
+      --color-code-background: #202020;
+  --color-code-foreground: #d0d0d0;
+
+    }
+    @media (prefers-color-scheme: dark) {
+      body:not([data-theme="light"]) {
+        --color-code-background: #202020;
+  --color-code-foreground: #d0d0d0;
+
+      }
+    }
+  }
+</style></head>
+  <body>
+
+    <script>
+      document.body.dataset.theme = localStorage.getItem("theme") || "auto";
+    </script>
+
+
+<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
+  <symbol id="svg-toc" viewBox="0 0 24 24">
+    <title>Contents</title>
+    <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
+      <path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
+    </svg>
+  </symbol>
+  <symbol id="svg-menu" viewBox="0 0 24 24">
+    <title>Menu</title>
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
+      <line x1="3" y1="12" x2="21" y2="12"></line>
+      <line x1="3" y1="6" x2="21" y2="6"></line>
+      <line x1="3" y1="18" x2="21" y2="18"></line>
+    </svg>
+  </symbol>
+  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
+    <title>Expand</title>
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
+      <polyline points="9 18 15 12 9 6"></polyline>
+    </svg>
+  </symbol>
+  <symbol id="svg-sun" viewBox="0 0 24 24">
+    <title>Light mode</title>
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
+      <circle cx="12" cy="12" r="5"></circle>
+      <line x1="12" y1="1" x2="12" y2="3"></line>
+      <line x1="12" y1="21" x2="12" y2="23"></line>
+      <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
+      <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
+      <line x1="1" y1="12" x2="3" y2="12"></line>
+      <line x1="21" y1="12" x2="23" y2="12"></line>
+      <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
+      <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
+    </svg>
+  </symbol>
+  <symbol id="svg-moon" viewBox="0 0 24 24">
+    <title>Dark mode</title>
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
+      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
+      <path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
+    </svg>
+  </symbol>
+  <symbol id="svg-sun-half" viewBox="0 0 24 24">
+    <title>Auto light/dark mode</title>
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
+      <path stroke="none" d="M0 0h24v24H0z" fill="none"/>
+      <circle cx="12" cy="12" r="9" />
+      <path d="M13 12h5" />
+      <path d="M13 15h4" />
+      <path d="M13 18h1" />
+      <path d="M13 9h4" />
+      <path d="M13 6h1" />
+    </svg>
+  </symbol>
+</svg>
+
+<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
+<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
+<label class="overlay sidebar-overlay" for="__navigation">
+  <div class="visually-hidden">Hide navigation sidebar</div>
+</label>
+<label class="overlay toc-overlay" for="__toc">
+  <div class="visually-hidden">Hide table of contents sidebar</div>
+</label>
+
+
+
+<div class="page">
+  <header class="mobile-header">
+    <div class="header-left">
+      <label class="nav-overlay-icon" for="__navigation">
+        <div class="visually-hidden">Toggle site navigation sidebar</div>
+        <i class="icon"><svg><use href="#svg-menu"></use></svg></i>
+      </label>
+    </div>
+    <div class="header-center">
+      <a href="../index.html"><div class="brand">SVInsight  documentation</div></a>
+    </div>
+    <div class="header-right">
+      <div class="theme-toggle-container theme-toggle-header">
+        <button class="theme-toggle">
+          <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
+          <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
+          <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
+          <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
+        </button>
+      </div>
+      <label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
+        <div class="visually-hidden">Toggle table of contents sidebar</div>
+        <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
+      </label>
+    </div>
+  </header>
+  <aside class="sidebar-drawer">
+    <div class="sidebar-container">
+
+      <div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html">
+
+
+  <span class="sidebar-brand-text">SVInsight  documentation</span>
+
+</a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
+  <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
+  <input type="hidden" name="check_keywords" value="yes">
+  <input type="hidden" name="area" value="default">
+</form>
+<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
+  <ul>
+<li class="toctree-l1"><a class="reference internal" href="../Getting_Started/install.html">Install</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../Getting_Started/quickstart.html">Getting Started</a></li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../Background/background.html">Background</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../Background/paper.html">Paper</a></li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../User_Guide/userguide.html">User Guide</a></li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../Examples/examples.html">Examples</a></li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Acknowledgements</a></li>
+</ul>
+
+</div>
+</div>
+
+      </div>
+
+    </div>
+  </aside>
+  <div class="main">
+    <div class="content">
+      <div class="article-container">
+        <a href="#" class="back-to-top muted-link">
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
+            <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
+          </svg>
+          <span>Back to top</span>
+        </a>
+        <div class="content-icon-container">
+
+<div class="theme-toggle-container theme-toggle-content">
+            <button class="theme-toggle">
+              <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
+              <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
+              <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
+              <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
+            </button>
+          </div>
+          <label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
+            <div class="visually-hidden">Toggle table of contents sidebar</div>
+            <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
+          </label>
+        </div>
+        <article role="main">
+          <section id="acknowledgements">
+<h1>Acknowledgements<a class="headerlink" href="#acknowledgements" title="Link to this heading">#</a></h1>
+<p>Funding sources and lab information goes here.</p>
+</section>
+
+        </article>
+      </div>
+      <footer>
+
+        <div class="related-pages">
+
+          <a class="prev-page" href="../Examples/examples.html">
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
+              <div class="page-info">
+                <div class="context">
+                  <span>Previous</span>
+                </div>
+
+                <div class="title">Examples</div>
+
+              </div>
+            </a>
+        </div>
+        <div class="bottom-of-page">
+          <div class="left-details">
+            <div class="copyright">
+                Copyright &#169; 2024, Matthew Preisser
+            </div>
+            Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
+
+            <a href="https://github.com/pradyunsg/furo">Furo</a>
+
+          </div>
+          <div class="right-details">
+
+          </div>
+        </div>
+
+      </footer>
+    </div>
+    <aside class="toc-drawer no-toc">
+
+
+
+    </aside>
+  </div>
+</div><script src="../_static/documentation_options.js?v=5929fcd5"></script>
+    <script src="../_static/doctools.js?v=888ff710"></script>
+    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="../_static/scripts/furo.js?v=32e29ea5"></script>
+    </body>
+</html>