Update apidocs

wsp-sag · Aug 11, 2023 · 6b4db66 · 6b4db66
1 parent afc4383
commit 6b4db66
Show file tree

Hide file tree

Showing 19 changed files with 185 additions and 132 deletions.
diff --git a/apidoc/routines/io.rst b/apidoc/routines/io.rst
@@ -2,7 +2,7 @@
 IO Utilities
 ============
 
-Routines for reading and writing demand modelling files, particularly matrices and TMG Toolbox network packages.
+Routines for reading and writing demand modelling files, particularly matrices and TMGToolbox network packages.
 
 Matrices
 --------
@@ -38,5 +38,7 @@ Fortran format
 Network Packages (NWP)
 ----------------------
 
+For more information on the TMGToolbox Network Package format, please visit https://tmg.utoronto.ca/doc/1.6/tmgtoolbox/input_output/ExportNetworkPackage.html
+
 .. automodule:: balsa.routines.io.nwp
    :members:
diff --git a/docs/.buildinfo b/docs/.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: e9c765a95887a75c9a2e673fd39b858c
+config: 2d7548e41818fc7ff042dc792b902925
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_sources/routines/io.rst.txt b/docs/_sources/routines/io.rst.txt
@@ -2,7 +2,7 @@
 IO Utilities
 ============
 
-Routines for reading and writing demand modelling files, particularly matrices and TMG Toolbox network packages.
+Routines for reading and writing demand modelling files, particularly matrices and TMGToolbox network packages.
 
 Matrices
 --------
@@ -38,5 +38,7 @@ Fortran format
 Network Packages (NWP)
 ----------------------
 
+For more information on the TMGToolbox Network Package format, please visit https://tmg.utoronto.ca/doc/1.6/tmgtoolbox/input_output/ExportNetworkPackage.html
+
 .. automodule:: balsa.routines.io.nwp
    :members:
diff --git a/docs/_static/basic.css b/docs/_static/basic.css
@@ -670,6 +670,16 @@ dd {
     margin-left: 30px;
 }
 
+.sig dd {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
+.sig dl {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
 dl > dd:last-child,
 dl > dd:last-child > :last-child {
     margin-bottom: 0;
@@ -738,6 +748,14 @@ abbr, acronym {
     cursor: help;
 }
 
+.translated {
+    background-color: rgba(207, 255, 207, 0.2)
+}
+
+.untranslated {
+    background-color: rgba(255, 207, 207, 0.2)
+}
+
 /* -- code displays --------------------------------------------------------- */
 
 pre {

diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '1.4.0',
+    VERSION: '1.4.2',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Index &#8212; wsp-balsa 1.4.0 documentation</title>
+    <title>Index &#8212; wsp-balsa 1.4.2 documentation</title>
 
 
 
@@ -27,15 +27,15 @@
 <link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2" />
 <link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2" />
 
-    <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
 
   <!-- Pre-loaded scripts that we'll load fully later -->
   <link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=e353d410970836974a52" />
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=e353d410970836974a52" />
 
-    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
-    <script src="_static/doctools.js"></script>
-    <script src="_static/sphinx_highlight.js"></script>
+    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=f7c0d94c"></script>
+    <script src="_static/doctools.js?v=888ff710"></script>
+    <script src="_static/sphinx_highlight.js?v=4825356b"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = 'genindex';</script>
     <link rel="index" title="Index" href="#" />
     <link rel="search" title="Search" href="search.html" />
@@ -558,10 +558,12 @@ <h2 id="O">O</h2>
 <h2 id="P">P</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="routines/io.html#balsa.routines.io.inro.peek_mdf">peek_mdf() (in module balsa.routines.io.inro)</a>
+      <li><a href="routines/io.html#balsa.routines.io.nwp.parse_tmg_ncs_line_id">parse_tmg_ncs_line_id() (in module balsa.routines.io.nwp)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="routines/io.html#balsa.routines.io.inro.peek_mdf">peek_mdf() (in module balsa.routines.io.inro)</a>
+</li>
       <li><a href="routines/io.html#balsa.routines.io.nwp.process_emme_eng_notation_series">process_emme_eng_notation_series() (in module balsa.routines.io.nwp)</a>
 </li>
   </ul></td>
@@ -586,10 +588,10 @@ <h2 id="R">R</h2>
 </li>
       <li><a href="routines/io.html#balsa.routines.io.nwp.read_nwp_node_attributes">read_nwp_node_attributes() (in module balsa.routines.io.nwp)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="routines/io.html#balsa.routines.io.nwp.read_nwp_traffic_results">read_nwp_traffic_results() (in module balsa.routines.io.nwp)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="routines/io.html#balsa.routines.io.nwp.read_nwp_traffic_results_at_countpost">read_nwp_traffic_results_at_countpost() (in module balsa.routines.io.nwp)</a>
 </li>
       <li><a href="routines/io.html#balsa.routines.io.nwp.read_nwp_transit_line_attributes">read_nwp_transit_line_attributes() (in module balsa.routines.io.nwp)</a>
@@ -601,6 +603,8 @@ <h2 id="R">R</h2>
       <li><a href="routines/io.html#balsa.routines.io.nwp.read_nwp_transit_segment_results">read_nwp_transit_segment_results() (in module balsa.routines.io.nwp)</a>
 </li>
       <li><a href="routines/io.html#balsa.routines.io.nwp.read_nwp_transit_station_results">read_nwp_transit_station_results() (in module balsa.routines.io.nwp)</a>
+</li>
+      <li><a href="routines/io.html#balsa.routines.io.nwp.read_nwp_transit_vehicles">read_nwp_transit_vehicles() (in module balsa.routines.io.nwp)</a>
 </li>
       <li><a href="routines/io.html#balsa.routines.io.omx.read_omx">read_omx() (in module balsa.routines.io.omx)</a>
 </li>
@@ -701,7 +705,7 @@ <h2 id="T">T</h2>
 
         <div class="footer-item">
   <p class="sphinx-version">
-    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.0.1.
+    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.1.2.
     <br/>
   </p>
 </div>

diff --git a/docs/index.html b/docs/index.html
@@ -10,7 +10,7 @@
     <link href="_static/favicon-16x16.png" sizes="16x16" rel="icon" type="image/png">
     <link href="_static/favicon-32x32.png" sizes="32x32" rel="icon" type="image/png">
     <link rel="apple-touch-icon" href="_static/apple-touch-icon.png" sizes="180x180" type="image/png">
-    <title>wsp-balsa: Common modelling tools &#8212; wsp-balsa 1.4.0 documentation</title>
+    <title>wsp-balsa: Common modelling tools &#8212; wsp-balsa 1.4.2 documentation</title>
 
 
 
@@ -30,15 +30,15 @@
 <link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2" />
 <link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2" />
 
-    <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
 
   <!-- Pre-loaded scripts that we'll load fully later -->
   <link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=e353d410970836974a52" />
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=e353d410970836974a52" />
 
-    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
-    <script src="_static/doctools.js"></script>
-    <script src="_static/sphinx_highlight.js"></script>
+    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=f7c0d94c"></script>
+    <script src="_static/doctools.js?v=888ff710"></script>
+    <script src="_static/sphinx_highlight.js?v=4825356b"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = 'index';</script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
@@ -332,7 +332,7 @@ <h1>wsp-balsa: Common modelling tools<a class="headerlink" href="#wsp-balsa-comm
 </li>
 <li class="toctree-l2"><a class="reference internal" href="routines/io.html">IO Utilities</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="routines/io.html#matrices">Matrices</a></li>
-<li class="toctree-l3"><a class="reference internal" href="routines/io.html#module-balsa.routines.io.nwp">Network Packages (NWP)</a></li>
+<li class="toctree-l3"><a class="reference internal" href="routines/io.html#network-packages-nwp">Network Packages (NWP)</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="routines/modelling.html">Modelling Utilities</a><ul>
@@ -455,7 +455,7 @@ <h1>wsp-balsa: Common modelling tools<a class="headerlink" href="#wsp-balsa-comm
 
         <div class="footer-item">
   <p class="sphinx-version">
-    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.0.1.
+    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.1.2.
     <br/>
   </p>
 </div>

diff --git a/docs/logging/index.html b/docs/logging/index.html
@@ -10,7 +10,7 @@
     <link href="../_static/favicon-16x16.png" sizes="16x16" rel="icon" type="image/png">
     <link href="../_static/favicon-32x32.png" sizes="32x32" rel="icon" type="image/png">
     <link rel="apple-touch-icon" href="../_static/apple-touch-icon.png" sizes="180x180" type="image/png">
-    <title>Logging &#8212; wsp-balsa 1.4.0 documentation</title>
+    <title>Logging &#8212; wsp-balsa 1.4.2 documentation</title>
 
 
 
@@ -30,15 +30,15 @@
 <link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2" />
 <link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2" />
 
-    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
 
   <!-- Pre-loaded scripts that we'll load fully later -->
   <link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=e353d410970836974a52" />
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=e353d410970836974a52" />
 
-    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
-    <script src="../_static/doctools.js"></script>
-    <script src="../_static/sphinx_highlight.js"></script>
+    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=f7c0d94c"></script>
+    <script src="../_static/doctools.js?v=888ff710"></script>
+    <script src="../_static/sphinx_highlight.js?v=4825356b"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = 'logging/index';</script>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
@@ -343,9 +343,8 @@ <h1>Logging<a class="headerlink" href="#logging" title="Permalink to this headin
 <p>Collection of classes and functions to configuration Python Logger objects, re-purposed to provide detailed status messages during model program execution.</p>
 <span class="target" id="module-balsa.logging"></span><dl class="py class">
 <dt class="sig sig-object py" id="balsa.logging.LogFormats">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">balsa.logging.</span></span><span class="sig-name descname"><span class="pre">LogFormats</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#balsa.logging.LogFormats" title="Permalink to this definition">#</a></dt>
-<dd><p>An enumeration.</p>
-</dd></dl>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">balsa.logging.</span></span><span class="sig-name descname"><span class="pre">LogFormats</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">module</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">qualname</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">boundary</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#balsa.logging.LogFormats" title="Permalink to this definition">#</a></dt>
+<dd></dd></dl>
 
 <dl class="py class">
 <dt class="sig sig-object py" id="balsa.logging.ModelLogger">
@@ -502,7 +501,7 @@ <h1>Logging<a class="headerlink" href="#logging" title="Permalink to this headin
 
         <div class="footer-item">
   <p class="sphinx-version">
-    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.0.1.
+    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.1.2.
     <br/>
   </p>
 </div>

diff --git a/docs/objects.inv b/docs/objects.inv
diff --git a/docs/py-modindex.html b/docs/py-modindex.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Python Module Index &#8212; wsp-balsa 1.4.0 documentation</title>
+    <title>Python Module Index &#8212; wsp-balsa 1.4.2 documentation</title>
 
 
 
@@ -27,15 +27,15 @@
 <link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2" />
 <link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2" />
 
-    <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
 
   <!-- Pre-loaded scripts that we'll load fully later -->
   <link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=e353d410970836974a52" />
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=e353d410970836974a52" />
 
-    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
-    <script src="_static/doctools.js"></script>
-    <script src="_static/sphinx_highlight.js"></script>
+    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=f7c0d94c"></script>
+    <script src="_static/doctools.js?v=888ff710"></script>
+    <script src="_static/sphinx_highlight.js?v=4825356b"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = 'py-modindex';</script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
@@ -432,7 +432,7 @@ <h1>Python Module Index</h1>
 
         <div class="footer-item">
   <p class="sphinx-version">
-    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.0.1.
+    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.1.2.
     <br/>
   </p>
 </div>