deploy: f0f1ef0

PeopleForBikes · Feb 20, 2024 · c0f1457 · c0f1457
1 parent b25cc68
commit c0f1457
Show file tree

Hide file tree

Showing 54 changed files with 5,809 additions and 2,308 deletions.
diff --git a/.buildinfo b/.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: 2d10feb25651700201510a8628ad29dd
+config: 68d97ff24f058c071b0b18c5da78c879
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/CHANGELOG.html b/CHANGELOG.html
diff --git a/CONTRIBUTING.html b/CONTRIBUTING.html
diff --git a/README.html b/README.html
@@ -3,10 +3,10 @@
   <head><meta charset="utf-8"/>
     <meta name="viewport" content="width=device-width,initial-scale=1"/>
     <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
-<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" />
+<link rel="author" title="About these documents" href="about.html" /><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" />
 
-    <!-- Generated with Sphinx 7.2.5 and Furo 2023.09.10 -->
-        <title>Brokenspoke-analyzer - Brokenspoke Analyzer 2.0.0a0 documentation</title>
+    <!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 -->
+        <title>Brokenspoke-analyzer - Brokenspoke Analyzer 2.0.0 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=135e06be" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
@@ -164,7 +164,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand">Brokenspoke Analyzer 2.0.0a0 documentation</div></a>
+      <a href="index.html"><div class="brand">Brokenspoke Analyzer 2.0.0 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -187,7 +187,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
 
 
-  <span class="sidebar-brand-text">Brokenspoke Analyzer 2.0.0a0 documentation</span>
+  <span class="sidebar-brand-text">Brokenspoke Analyzer 2.0.0 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">
@@ -197,9 +197,9 @@
 <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
   <p class="caption" role="heading"><span class="caption-text">GENERAL:</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="usage.html">Usages</a></li>
+<li class="toctree-l1"><a class="reference internal" href="about.html">About</a></li>
 <li class="toctree-l1"><a class="reference internal" href="commands.html">Commands</a></li>
-<li class="toctree-l1"><a class="reference internal" href="datasets.html">Datasets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="regions.html">Regions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="workflow.html">Preparation Workflow</a></li>
 <li class="toctree-l1"><a class="reference internal" href="resources.html">Resources</a></li>
 <li class="toctree-l1"><a class="reference internal" href="CHANGELOG.html">Changelog</a></li>
@@ -211,11 +211,18 @@
 <li class="toctree-l1 has-children"><a class="reference internal" href="api/brokenspoke_analyzer.html">brokenspoke_analyzer package</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of brokenspoke_analyzer package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
 <li class="toctree-l2 has-children"><a class="reference internal" href="api/brokenspoke_analyzer.core.html">brokenspoke_analyzer.core package</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of brokenspoke_analyzer.core package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
 <li class="toctree-l3"><a class="reference internal" href="api/brokenspoke_analyzer.core.analysis.html">brokenspoke_analyzer.core.analysis module</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/brokenspoke_analyzer.core.compute.html">brokenspoke_analyzer.core.compute module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="api/brokenspoke_analyzer.core.downloader.html">brokenspoke_analyzer.core.downloader module</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/brokenspoke_analyzer.core.exporter.html">brokenspoke_analyzer.core.exporter module</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/brokenspoke_analyzer.core.ingestor.html">brokenspoke_analyzer.core.ingestor module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="api/brokenspoke_analyzer.core.runner.html">brokenspoke_analyzer.core.runner module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="api/brokenspoke_analyzer.core.utils.html">brokenspoke_analyzer.core.utils module</a></li>
 </ul>
 </li>
+<li class="toctree-l2 has-children"><a class="reference internal" href="api/brokenspoke_analyzer.core.database.html">brokenspoke_analyzer.core.database package</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of brokenspoke_analyzer.core.database package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
+<li class="toctree-l3"><a class="reference internal" href="api/brokenspoke_analyzer.core.database.dbcore.html">brokenspoke_analyzer.core.database.dbcore package</a></li>
+</ul>
+</li>
 </ul>
 </li>
 </ul>
@@ -280,29 +287,28 @@ <h2>Requirements<a class="headerlink" href="#requirements" title="Link to this h
 </section>
 <section id="quickstart">
 <h2>Quickstart<a class="headerlink" href="#quickstart" title="Link to this heading">#</a></h2>
-<p>We recommend creating a virtual environment, but this is completely optional:</p>
-<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span>/tmp
-mkdir<span class="w"> </span>brokenspoke-analyzer
+<p>We recommend using <a class="reference external" href="https://python-poetry.org/">Poetry</a> for installing the tool
+and working in a virtual environment. Once you have Poetry set up:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>clone<span class="w"> </span>git@github.com:PeopleForBikes/brokenspoke-analyzer.git
 <span class="nb">cd</span><span class="w"> </span>brokenspoke-analyzer
-python3<span class="w"> </span>-m<span class="w"> </span>venv<span class="w"> </span>.venv
-<span class="nb">source</span><span class="w"> </span>.venv/bin/activate
+poetry<span class="w"> </span>install
 </pre></div>
 </div>
-<p>Install the application using <code class="docutils literal notranslate"><span class="pre">pip</span></code>:</p>
-<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>git+https://github.com/PeopleForBikes/brokenspoke-analyzer@2.0.0-alpha
+<p>Activate the virtual environment in the cloned folder by using:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">source</span><span class="w"> </span>.venv/bin/activate
 </pre></div>
 </div>
 <p>The simplest way to run an analysis is to use docker compose.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>bna<span class="w"> </span>run-with<span class="w"> </span>compose<span class="w"> </span>usa<span class="w"> </span><span class="s2">&quot;santa rosa&quot;</span><span class="w"> </span><span class="s2">&quot;new mexico&quot;</span><span class="w"> </span><span class="m">3570670</span>
 </pre></div>
 </div>
 <p>This command takes care of starting and stopping the PostgreSQL/PostGIS server,
-running all the analysis commands and exporting the results.</p>
+running all the analysis commands, and exporting the results.</p>
 <p>The data required to perform the analysis will be saved in
 <code class="docutils literal notranslate"><span class="pre">data/santa-rosa-new-mexico-usa</span></code>, and the results exported in
-<code class="docutils literal notranslate"><span class="pre">data/santa-rosa-new-mexico-usa/results/usa/new</span> <span class="pre">mexico/santa</span> <span class="pre">rosa/</span></code></p>
+<code class="docutils literal notranslate"><span class="pre">results/usa/new</span> <span class="pre">mexico/santa</span> <span class="pre">rosa/23.11</span></code>.</p>
 <p>For more details about the different ways to run an analysis and how to adjust
-the options, please refer to full documentation.</p>
+the options, please refer to the full documentation.</p>
 </section>
 </section>
 
@@ -364,7 +370,7 @@ <h2>Quickstart<a class="headerlink" href="#quickstart" title="Link to this headi
 
     </aside>
   </div>
-</div><script src="_static/documentation_options.js?v=30372d7b"></script>
+</div><script src="_static/documentation_options.js?v=51b770b3"></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>

diff --git a/_images/brokenspoke-analyzer-architecture.svg b/_images/brokenspoke-analyzer-architecture.svg
diff --git a/_images/graphviz-a82104d9e83cf47b89159ea4f48b1f958a0ba5d3.png b/_images/graphviz-a82104d9e83cf47b89159ea4f48b1f958a0ba5d3.png
diff --git a/_images/graphviz-a82104d9e83cf47b89159ea4f48b1f958a0ba5d3.png.map b/_images/graphviz-a82104d9e83cf47b89159ea4f48b1f958a0ba5d3.png.map
diff --git a/_images/graphviz-fdbd7d671fb91610894cde16781b720a53133ed4.png b/_images/graphviz-fdbd7d671fb91610894cde16781b720a53133ed4.png
diff --git a/_images/graphviz-fdbd7d671fb91610894cde16781b720a53133ed4.png.map b/_images/graphviz-fdbd7d671fb91610894cde16781b720a53133ed4.png.map
diff --git a/_sources/CHANGELOG.md.txt b/_sources/CHANGELOG.md.txt
@@ -2,26 +2,80 @@
 
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to
-[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+The format is based on [Keep a Changelog], and this project adheres to [Semantic
+Versioning].
 
 ## [Unreleased]
 
+## [2.0.0] - 2024-02-19
+
+We are incredibly proud to announce the release of version 2.0.0 of the
+brokenspoke-analyzer, a significant milestone marking a comprehensive overhaul
+of the original Bicycle Network Analyzer.
+
+In the process of rewriting the original tool, and incorporating it into the
+brokenspoke-analyzer, a myriad of changes and improvements were implemented to
+enhance its functionality and performance.
+
+However, given the extensive nature of these modifications, providing a detailed
+changelog for every feature proved impractical and overwhelming.
+
+Instead, the decision was made to focus on the overarching shift from Bash to
+Python in the changelog, emphasizing the fundamental improvements and the
+migration to a more robust programming language.
+
+Moving forward, a commitment has been made to maintain a comprehensive and
+up-to-date changelog, ensuring that all future enhancements and features will be
+meticulously documented to provide transparency and facilitate user
+understanding.
+
+[2.0.0]: https://github.com/PeopleForBikes/brokenspoke-analyzer/releases/tag/2.0.0
+
 ## [2.0.0-alpha] - 2023-09-16
 
 ### Added
 
-- Add Python scripts for code originally written in Bash.
-- Add integration test suite.
-- Update the documentation to include new subcommands and features.
+- Add Python scripts for importing data into database and configuring database.
+  [#265]
+- Enable MyPy to ensure coherence between the various parameters passed from the
+  command line to the core modules. [#282]
+- Add Python scripts for computing the analysis. [#291]
+- Add Python scripts for exporting the results of the analysis using the calver
+  naming scheme. [#294]
+- Add the capability to package the application as a Docker container. [#301]
+- Add the `run` sub-command. [#305]
+- Add the `run-with` sub-command. [#310]
+- Add the `run-with compare` sub-command. [#315]
+- Add end-to-end testing for comparing the results between the brokenspokespoke
+  analyzer and the original BNA. [#316]
+- Add a new CI workflow to run end-to-end tests. [#321]
+- Add a feature to validate downloaded PBF OpenStreetMap files using md5
+  checksums and gzip files using the `gzip` package. [#329]
 
 ### Changed
 
-- Update and reorganize the CLI.
+- Update and reorganize the CLI. [#274]
+- Update the documentation. [#330]
+
+### Fixed
 
-[2.0.0-alpha]:
-  https://github.com/PeopleForBikes/brokenspoke-analyzer/releases/tag/2.0.0-alpha
+- Various SQL-related fixes. [#320]
+
+[#265]: https://github.com/PeopleForBikes/brokenspoke-analyzer/pull/265
+[#274]: https://github.com/PeopleForBikes/brokenspoke-analyzer/pull/274
+[#282]: https://github.com/PeopleForBikes/brokenspoke-analyzer/pull/282
+[#291]: https://github.com/PeopleForBikes/brokenspoke-analyzer/pull/291
+[#294]: https://github.com/PeopleForBikes/brokenspoke-analyzer/pull/294
+[#301]: https://github.com/PeopleForBikes/brokenspoke-analyzer/pull/301
+[#305]: https://github.com/PeopleForBikes/brokenspoke-analyzer/pull/305
+[#310]: https://github.com/PeopleForBikes/brokenspoke-analyzer/pull/310
+[#315]: https://github.com/PeopleForBikes/brokenspoke-analyzer/pull/315
+[#316]: https://github.com/PeopleForBikes/brokenspoke-analyzer/pull/316
+[#320]: https://github.com/PeopleForBikes/brokenspoke-analyzer/pull/320
+[#321]: https://github.com/PeopleForBikes/brokenspoke-analyzer/pull/321
+[#329]: https://github.com/PeopleForBikes/brokenspoke-analyzer/pull/329
+[#330]: https://github.com/PeopleForBikes/brokenspoke-analyzer/pull/330
+[2.0.0-alpha]: https://github.com/PeopleForBikes/brokenspoke-analyzer/releases/tag/2.0.0-alpha
 
 ## [1.3.0] - 2023-08-20
 
@@ -58,8 +112,7 @@ and this project adheres to
 [#240]: https://github.com/PeopleForBikes/brokenspoke-analyzer/pull/240
 [#259]: https://github.com/PeopleForBikes/brokenspoke-analyzer/pull/259
 [#272]: https://github.com/PeopleForBikes/brokenspoke-analyzer/pull/272
-[1.3.0]:
-  https://github.com/PeopleForBikes/brokenspoke-analyzer/releases/tag/1.3.0
+[1.3.0]: https://github.com/PeopleForBikes/brokenspoke-analyzer/releases/tag/1.3.0
 
 ## [1.2.1] - 2023-06-18
 
@@ -70,8 +123,7 @@ and this project adheres to
 
 [#205]: https://github.com/PeopleForBikes/brokenspoke-analyzer/pull/205
 [#206]: https://github.com/PeopleForBikes/brokenspoke-analyzer/pull/206
-[1.2.1]:
-  https://github.com/PeopleForBikes/brokenspoke-analyzer/releases/tag/1.2.1
+[1.2.1]: https://github.com/PeopleForBikes/brokenspoke-analyzer/releases/tag/1.2.1
 
 ## [1.2.0] - 2023-06-14
 
@@ -91,8 +143,7 @@ and this project adheres to
 [#152]: https://github.com/PeopleForBikes/brokenspoke-analyzer/pull/152
 [#190]: https://github.com/PeopleForBikes/brokenspoke-analyzer/pull/190
 [#191]: https://github.com/PeopleForBikes/brokenspoke-analyzer/pull/191
-[1.2.0]:
-  https://github.com/PeopleForBikes/brokenspoke-analyzer/releases/tag/1.2.0
+[1.2.0]: https://github.com/PeopleForBikes/brokenspoke-analyzer/releases/tag/1.2.0
 
 ## [1.1.0] - 2022-10-08
 
@@ -105,15 +156,13 @@ and this project adheres to
 - Updated the analyzer image to 0.16.1. [#52]
 
 [#52]: https://github.com/PeopleForBikes/brokenspoke-analyzer/pull/52
-[1.1.0]:
-  https://github.com/PeopleForBikes/brokenspoke-analyzer/releases/tag/1.1.0
+[1.1.0]: https://github.com/PeopleForBikes/brokenspoke-analyzer/releases/tag/1.1.0
 
 ## [1.0.0] - 2022-08-14
 
 First stable version.
 
-[1.0.0]:
-  https://github.com/PeopleForBikes/brokenspoke-analyzer/releases/tag/1.0.0
+[1.0.0]: https://github.com/PeopleForBikes/brokenspoke-analyzer/releases/tag/1.0.0
 
 ## [1.0.0-rc.1] - 2022-08-07
 
@@ -123,5 +172,6 @@ the world (although the analyzer will fail for some of them).
 The tool is still a bit rough on the edges, that is why this is a release
 candidate, but the quirks will be ironned out for 1.0.0.
 
-[1.0.0-rc.1]:
-  https://github.com/PeopleForBikes/brokenspoke-analyzer/releases/tag/1.0.0-rc.1
+[1.0.0-rc.1]: https://github.com/PeopleForBikes/brokenspoke-analyzer/releases/tag/1.0.0-rc.1
+[Keep a Changelog]: https://keepachangelog.com/en/1.0.0/
+[Semantic Versioning]: https://semver.org/spec/v2.0.0.html