added initial docs

Urban-Meteorology-Reading · Nov 27, 2023 · cad7650 · cad7650
1 parent 83a812b
commit cad7650
Show file tree

Hide file tree

Showing 115 changed files with 13,819 additions and 0 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/build/doctrees/Citizen.doctree b/docs/build/doctrees/Citizen.doctree
diff --git a/docs/build/doctrees/EnergyCalc.doctree b/docs/build/doctrees/EnergyCalc.doctree
diff --git a/docs/build/doctrees/Initialise.doctree b/docs/build/doctrees/Initialise.doctree
diff --git a/docs/build/doctrees/Initialise_nhoods.doctree b/docs/build/doctrees/Initialise_nhoods.doctree
diff --git a/docs/build/doctrees/Main_run.doctree b/docs/build/doctrees/Main_run.doctree
diff --git a/docs/build/doctrees/Movement.doctree b/docs/build/doctrees/Movement.doctree
diff --git a/docs/build/doctrees/Nhood.doctree b/docs/build/doctrees/Nhood.doctree
diff --git a/docs/build/doctrees/Profile.doctree b/docs/build/doctrees/Profile.doctree
diff --git a/docs/build/doctrees/STEBBS.doctree b/docs/build/doctrees/STEBBS.doctree
diff --git a/docs/build/doctrees/SolveGraph.doctree b/docs/build/doctrees/SolveGraph.doctree
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
diff --git a/docs/build/doctrees/load_solved_graphs.doctree b/docs/build/doctrees/load_solved_graphs.doctree
diff --git a/docs/build/doctrees/modules.doctree b/docs/build/doctrees/modules.doctree
diff --git a/docs/build/doctrees/multi_processing.doctree b/docs/build/doctrees/multi_processing.doctree
diff --git a/docs/build/doctrees/plotting.doctree b/docs/build/doctrees/plotting.doctree
diff --git a/docs/build/doctrees/serialize_travel_graphs.doctree b/docs/build/doctrees/serialize_travel_graphs.doctree
diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo
@@ -0,0 +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: b4aaa4cb3370424f40c61fa4f5d134f3
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/html/Citizen.html b/docs/build/html/Citizen.html
diff --git a/docs/build/html/EnergyCalc.html b/docs/build/html/EnergyCalc.html
diff --git a/docs/build/html/Initialise.html b/docs/build/html/Initialise.html
@@ -0,0 +1,171 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Initialise module &mdash; DAVE  documentation</title>
+      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <!--[if lt IE 9]>
+    <script src="_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <script src="_static/jquery.js?v=5d32c60e"></script>
+        <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <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/js/theme.js"></script>
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="Initialise_nhoods module" href="Initialise_nhoods.html" />
+    <link rel="prev" title="EnergyCalc module" href="EnergyCalc.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="index.html" class="icon icon-home">
+            DAVE
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="Citizen.html">Citizen module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="EnergyCalc.html">EnergyCalc module</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Initialise module</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#Initialise.Grid"><code class="docutils literal notranslate"><span class="pre">Grid</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="#Initialise.Journey"><code class="docutils literal notranslate"><span class="pre">Journey</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="#Initialise.assign_all_school_work_places"><code class="docutils literal notranslate"><span class="pre">assign_all_school_work_places()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="#Initialise.assign_school_work_place"><code class="docutils literal notranslate"><span class="pre">assign_school_work_place()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="#Initialise.create_all_citizens"><code class="docutils literal notranslate"><span class="pre">create_all_citizens()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="#Initialise.create_all_profiles"><code class="docutils literal notranslate"><span class="pre">create_all_profiles()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="#Initialise.relative_path_to_absolute_path"><code class="docutils literal notranslate"><span class="pre">relative_path_to_absolute_path()</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="Initialise_nhoods.html">Initialise_nhoods module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="Main_run.html">Main_run module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="Movement.html">Movement module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="Nhood.html">Nhood module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="Profile.html">Profile module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="STEBBS.html">STEBBS module</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="index.html">DAVE</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
+      <li class="breadcrumb-item active">Initialise module</li>
+      <li class="wy-breadcrumbs-aside">
+            <a href="_sources/Initialise.rst.txt" rel="nofollow"> View page source</a>
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <section id="module-Initialise">
+<span id="initialise-module"></span><h1>Initialise module<a class="headerlink" href="#module-Initialise" title="Link to this heading"></a></h1>
+<p>Functions for initialising citizen and nhood objects.</p>
+<p>Megan McGrory - Feb 2023</p>
+<dl class="py class">
+<dt class="sig sig-object py" id="Initialise.Grid">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">Initialise.</span></span><span class="sig-name descname"><span class="pre">Grid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">journeys</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stations</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#Initialise.Grid" title="Link to this definition"></a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="Initialise.Journey">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">Initialise.</span></span><span class="sig-name descname"><span class="pre">Journey</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">destination</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">time</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mode</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#Initialise.Journey" title="Link to this definition"></a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Initialise.assign_all_school_work_places">
+<span class="sig-prename descclassname"><span class="pre">Initialise.</span></span><span class="sig-name descname"><span class="pre">assign_all_school_work_places</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">all_citizens</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">all_nhoods</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#Initialise.assign_all_school_work_places" title="Link to this definition"></a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Initialise.assign_school_work_place">
+<span class="sig-prename descclassname"><span class="pre">Initialise.</span></span><span class="sig-name descname"><span class="pre">assign_school_work_place</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">all_nhoods</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">citizen</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#Initialise.assign_school_work_place" title="Link to this definition"></a></dt>
+<dd><p>Assign citizen with a school or work grid depending on age group.</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Initialise.create_all_citizens">
+<span class="sig-prename descclassname"><span class="pre">Initialise.</span></span><span class="sig-name descname"><span class="pre">create_all_citizens</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Initialise.create_all_citizens" title="Link to this definition"></a></dt>
+<dd><p>Create dictionary of citizen objects, classified by age group.</p>
+<section id="returns">
+<h2>Returns<a class="headerlink" href="#returns" title="Link to this heading"></a></h2>
+<p>all_citizens: dict</p>
+</section>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Initialise.create_all_profiles">
+<span class="sig-prename descclassname"><span class="pre">Initialise.</span></span><span class="sig-name descname"><span class="pre">create_all_profiles</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">all_energy_profiles</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#Initialise.create_all_profiles" title="Link to this definition"></a></dt>
+<dd><p>Create dict of profiles from input files.</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="Initialise.relative_path_to_absolute_path">
+<span class="sig-prename descclassname"><span class="pre">Initialise.</span></span><span class="sig-name descname"><span class="pre">relative_path_to_absolute_path</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">relative_path</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#Initialise.relative_path_to_absolute_path" title="Link to this definition"></a></dt>
+<dd></dd></dl>
+
+</section>
+
+
+           </div>
+          </div>
+          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
+        <a href="EnergyCalc.html" class="btn btn-neutral float-left" title="EnergyCalc module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="Initialise_nhoods.html" class="btn btn-neutral float-right" title="Initialise_nhoods module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+    </div>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2023, Megan McGrory.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>