<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="canonical" href="https://OLC-LOC-Bioinformatics.github.io/AzureStorage/install/">
<link rel="shortcut icon" href="../img/favicon.ico">
<title>Installation - OLC Bioinformatics Azure Storage</title>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700" />
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "Installation";
var mkdocs_page_input_path = "install.md";
var mkdocs_page_url = "/AzureStorage/install/";
</script>
<script src="../js/jquery-2.1.1.min.js" defer></script>
<script src="../js/modernizr-2.8.3.min.js" defer></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> OLC Bioinformatics Azure Storage</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" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
</li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="./">Installation</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#conda">Conda</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#azurestorage">AzureStorage</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#create-new-conda-environment">Create new conda environment</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#install-in-existing-python-385-environment">Install in existing Python 3.8.5 environment</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#credentials">Credentials</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#tests">Tests</a>
</li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../credentials/">Credentials</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../upload/">Upload</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../sas_url/">SAS URL</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../move/">Move</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../download/">Download</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../set_tier/">Set Tier</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../delete/">Delete</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../automate/">Automate</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../list/">List</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">OLC Bioinformatics Azure Storage</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="..">Docs</a> »</li>
<li>Installation</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/OLC-LOC-Bioinformatics/AzureStorage/edit/main/docs/install.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<h2 id="installation">Installation</h2>
<p>AzureStorage is available as a conda package, so conda must be installed on your system.</p>
<h3 id="conda">Conda</h3>
<p>Skip this step if you have already installed conda</p>
<pre><code>wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh;
bash miniconda.sh -b -p $HOME/miniconda
conda update -q conda
</code></pre>
<h3 id="azurestorage">AzureStorage</h3>
<h4 id="create-new-conda-environment">Create new conda environment</h4>
<p><code>conda create -n azure_storage -c olcbioinformatics azure_storage</code></p>
<h4 id="install-in-existing-python-385-environment">Install in existing Python 3.8.5 environment</h4>
<p>Install the AzureStorage package:</p>
<p><code>conda install -c olcbioinformatics azure_storage</code></p>
<h3 id="credentials">Credentials</h3>
<p>You must enter your Azure storage connection string and account name into the system keyring before running any of the other scripts</p>
<p><a href="https://docs.microsoft.com/en-us/azure/storage/common/storage-configure-connection-string#:~:text=You%20can%20find%20your%20storage,primary%20and%20secondary%20access%20keys.">Find your connection string</a></p>
<p><a href="https://www.zenko.io/blog/how-to-find-keys-and-account-info-for-aws-azure-and-google/#:~:text=Azure%20Account%20Name%C2%A0%3D%20the%20name%20of%20your%20Azure%20storage%20account%20located%20on%20the%20top%20of%20the%20Azure%20Portal%20(screenshot%20below%20%E2%80%93%20%E2%80%9Cscalitydemo%E2%80%9D%20is%20Azure%20Account%20Name).">Find your account key</a></p>
<p>Once you know your account key and connection string, run:</p>
<p><code>AzureCredentials store</code></p>
<p>Your credentials will be securely stored in the system keyring</p>
<h3 id="tests">Tests</h3>
<p>If you encounter issues with the AzureStorage package, tests are available to ensure that the installation was successful and your credentials are valid.</p>
<p>You will need to clone this repository and run the tests with pytest</p>
<p><code>git clone https://github.com/OLC-LOC-Bioinformatics/AzureStorage.git</code></p>
<p><code>cd AzureStorage</code></p>
<p><code>python -m pytest tests/ --cov=azure_storage --cov-config=.coveragec</code></p>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../credentials/" class="btn btn-neutral float-right" title="Credentials">Next <span class="icon icon-circle-arrow-right"></span></a>
<a href=".." class="btn btn-neutral" title="Home"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<a href="https://github.com/OLC-LOC-Bioinformatics/AzureStorage/" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
<span><a href=".." style="color: #fcfcfc;">« Previous</a></span>
<span style="margin-left: 15px"><a href="../credentials/" style="color: #fcfcfc">Next »</a></span>
</span>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>