Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
sanjaynagi committed May 14, 2024
1 parent 3953ada commit 7b702d7
Show file tree
Hide file tree
Showing 10 changed files with 594 additions and 7 deletions.
46 changes: 46 additions & 0 deletions _sources/notebooks/data_access.ipynb
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
{
"cells": [
{
"attachments": {},
"cell_type": "markdown",
"id": "cce4eedb",
"metadata": {},
"source": [
"# Data Access\n",
"\n",
"## Accessing MalariaGEN Vector Observatory Data\n",
"\n",
"AnoPrimer relies on the malariagen_data package to access genetic variation data from wild whole-genome sequenced specimens of *An. gambiae* and *An. funestus*. Recently, the access process for the MalariaGEN Vector Observatory data has been updated. \n",
"\n",
"If using AnoPrimer within Google Colab, you will be asked to sign-in with your malariagen_data associated credentials. If using AnoPrimer elsewhere, you will need to set up your credentials as described in the [malariagen_data documentation](https://malariagen.github.io/vector-data/vobs/vobs-data-access.html).\n",
"\n"
]
}
],
"metadata": {
"kernelspec": {
"display_name": "Python 3 (ipykernel)",
"language": "python",
"name": "python3"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.6.9 (default, Nov 25 2022, 14:10:45) \n[GCC 8.4.0]"
},
"vscode": {
"interpreter": {
"hash": "31f2aee4e71d21fbe5cf8b01ff0e069b9275f58929596ceb00d14d90e3e16cd6"
}
}
},
"nbformat": 4,
"nbformat_minor": 5
}
1 change: 1 addition & 0 deletions genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,7 @@
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="notebooks/api.html">AnoPrimer API</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks/notebooks.html">Notebooks</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks/data_access.html">Data Access</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks/troubleshooting_contributing.html">Troubleshooting</a></li>

</ul>
Expand Down
2 changes: 2 additions & 0 deletions landing-page.html
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,7 @@
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="notebooks/api.html">AnoPrimer API</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks/notebooks.html">Notebooks</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks/data_access.html">Data Access</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks/troubleshooting_contributing.html">Troubleshooting</a></li>

</ul>
Expand Down Expand Up @@ -398,6 +399,7 @@ <h1>AnoPrimer<a class="headerlink" href="#anoprimer" title="Permalink to this he
<ul>
<li class="toctree-l1"><a class="reference internal" href="notebooks/api.html">AnoPrimer API</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks/notebooks.html">Notebooks</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks/data_access.html">Data Access</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks/troubleshooting_contributing.html">Troubleshooting</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks/troubleshooting_contributing.html#contributing">Contributing</a></li>
</ul>
Expand Down
1 change: 1 addition & 0 deletions notebooks/api.html
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,7 @@
<ul class="current nav bd-sidenav">
<li class="toctree-l1 current active"><a class="current reference internal" href="#">AnoPrimer API</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks.html">Notebooks</a></li>
<li class="toctree-l1"><a class="reference internal" href="data_access.html">Data Access</a></li>
<li class="toctree-l1"><a class="reference internal" href="troubleshooting_contributing.html">Troubleshooting</a></li>

</ul>
Expand Down
Loading

0 comments on commit 7b702d7

Please sign in to comment.