Skip to content

Commit

Permalink
Deploying to github_pages from @ 3924cd3 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
amrit110 committed Nov 12, 2024
1 parent a2febaf commit bf19924
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 13 deletions.
27 changes: 22 additions & 5 deletions _sources/index.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -91,18 +91,35 @@ docker compose --env-file .env.development --profile frontend -f docker-compose.

### 📥 Data setup

#### Download service data (211 API)
#### Test data

**GTA data**
If you want to test the system without real data, you can generate some dummy testing data:

```bash
python3 scripts/download_data.py --api-key $YOUR_211_API_KEY --dataset on --is-gta --data-dir <path_to_data_dir>
python3 scripts/generate_test_data.py
```

**Ontario-wide data**
#### Download service data

If you are using the 211 API or Empower's API, make sure you check with them to see if the API keys are
configured correctly for the geography of interest.

**GTA data (211 API)**

```bash
python3 scripts/download_211_data.py --api-key $YOUR_211_API_KEY --dataset on --is-gta --data-dir <path_to_data_dir>
```

**Ontario-wide data (211 API)**

```bash
python3 scripts/download_211_data.py --api-key $YOUR_211_API_KEY --dataset on --data-dir <path_to_data_dir>
```

**Empower API data**

```bash
python3 scripts/download_data.py --api-key $YOUR_211_API_KEY --dataset on --data-dir <path_to_data_dir>
python3 scripts/download_empower_data.py --api-key $YOUR_EMPOWER_API_KEY --data-dir <path_to_data_dir>
```

#### Upload data and embeddings
Expand Down
28 changes: 21 additions & 7 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -362,14 +362,27 @@ <h3>🏃‍♂️ Running the services<a class="headerlink" href="#running-the-s
</section>
<section id="data-setup">
<h3>📥 Data setup<a class="headerlink" href="#data-setup" title="Link to this heading"></a></h3>
<section id="download-service-data-211-api">
<h4>Download service data (211 API)<a class="headerlink" href="#download-service-data-211-api" title="Link to this heading"></a></h4>
<p><strong>GTA data</strong></p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python3<span class="w"> </span>scripts/download_data.py<span class="w"> </span>--api-key<span class="w"> </span><span class="nv">$YOUR_211_API_KEY</span><span class="w"> </span>--dataset<span class="w"> </span>on<span class="w"> </span>--is-gta<span class="w"> </span>--data-dir<span class="w"> </span>&lt;path_to_data_dir&gt;
<section id="test-data">
<h4>Test data<a class="headerlink" href="#test-data" title="Link to this heading"></a></h4>
<p>If you want to test the system without real data, you can generate some dummy testing data:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python3<span class="w"> </span>scripts/generate_test_data.py
</pre></div>
</div>
<p><strong>Ontario-wide data</strong></p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python3<span class="w"> </span>scripts/download_data.py<span class="w"> </span>--api-key<span class="w"> </span><span class="nv">$YOUR_211_API_KEY</span><span class="w"> </span>--dataset<span class="w"> </span>on<span class="w"> </span>--data-dir<span class="w"> </span>&lt;path_to_data_dir&gt;
</section>
<section id="download-service-data">
<h4>Download service data<a class="headerlink" href="#download-service-data" title="Link to this heading"></a></h4>
<p>If you are using the 211 API or Empower’s API, make sure you check with them to see if the API keys are
configured correctly for the geography of interest.</p>
<p><strong>GTA data (211 API)</strong></p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python3<span class="w"> </span>scripts/download_211_data.py<span class="w"> </span>--api-key<span class="w"> </span><span class="nv">$YOUR_211_API_KEY</span><span class="w"> </span>--dataset<span class="w"> </span>on<span class="w"> </span>--is-gta<span class="w"> </span>--data-dir<span class="w"> </span>&lt;path_to_data_dir&gt;
</pre></div>
</div>
<p><strong>Ontario-wide data (211 API)</strong></p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python3<span class="w"> </span>scripts/download_211_data.py<span class="w"> </span>--api-key<span class="w"> </span><span class="nv">$YOUR_211_API_KEY</span><span class="w"> </span>--dataset<span class="w"> </span>on<span class="w"> </span>--data-dir<span class="w"> </span>&lt;path_to_data_dir&gt;
</pre></div>
</div>
<p><strong>Empower API data</strong></p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python3<span class="w"> </span>scripts/download_empower_data.py<span class="w"> </span>--api-key<span class="w"> </span><span class="nv">$YOUR_EMPOWER_API_KEY</span><span class="w"> </span>--data-dir<span class="w"> </span>&lt;path_to_data_dir&gt;
</pre></div>
</div>
</section>
Expand Down Expand Up @@ -474,7 +487,8 @@ <h4>In case, you wish to update frontend dependencies, run the following command
<li><a class="reference internal" href="#installation">🛠️ Installation</a></li>
<li><a class="reference internal" href="#running-the-services">🏃‍♂️ Running the services</a></li>
<li><a class="reference internal" href="#data-setup">📥 Data setup</a><ul>
<li><a class="reference internal" href="#download-service-data-211-api">Download service data (211 API)</a></li>
<li><a class="reference internal" href="#test-data">Test data</a></li>
<li><a class="reference internal" href="#download-service-data">Download service data</a></li>
<li><a class="reference internal" href="#upload-data-and-embeddings">Upload data and embeddings</a></li>
<li><a class="reference internal" href="#navigate-to-the-ui-on-the-browser">Navigate to the UI on the browser</a></li>
<li><a class="reference internal" href="#in-case-you-wish-to-update-frontend-dependencies-run-the-following-commands-in-the-ui-directory">In case, you wish to update frontend dependencies, run the following commands in the <code class="docutils literal notranslate"><span class="pre">ui</span></code> directory:</a></li>
Expand Down
Loading

0 comments on commit bf19924

Please sign in to comment.