Deployed 7ae3a1d with MkDocs version: 1.3.1

This commit is contained in:
Gilles Boccon-Gibod
2022-12-18 20:55:03 -08:00
parent 3581c8d710
commit 5f0477bd28
53 changed files with 4623 additions and 561 deletions

View File

@@ -311,6 +311,34 @@
<li class="md-nav__item">
<a href="contributing.html" class="md-nav__link">
Contributing
</a>
</li>
<li class="md-nav__item">
<a href="code_style.html" class="md-nav__link">
Code Style
</a>
</li>
</ul>
</nav>
</li>
@@ -1287,26 +1315,26 @@
<h1 id="python-environments">PYTHON ENVIRONMENTS<a class="headerlink" href="#python-environments" title="Permanent link">&para;</a></h1>
<p>When you don't want to install Bumble in your main/default python environment,
<p>When you don't want to install Bumble in your main/default python environment,
using a virtual environment, where the package and its dependencies can be
installed, isolated from the rest, may be useful.</p>
<p>There are many flavors of python environments and dependency managers.
<p>There are many flavors of python environments and dependency managers.
This page describes a few of the most common ones.</p>
<h2 id="venv">venv<a class="headerlink" href="#venv" title="Permanent link">&para;</a></h2>
<p><code>venv</code> is a standard module that is included with python.
Visit the <a href="https://docs.python.org/3/library/venv.html"><code>venv</code> documentation</a> page for details.</p>
<h2 id="pyenv">Pyenv<a class="headerlink" href="#pyenv" title="Permanent link">&para;</a></h2>
<p><code>pyenv</code> lets you easily switch between multiple versions of Python. It's simple, unobtrusive, and follows the UNIX tradition of single-purpose tools that do one thing well.<br />
<p><code>pyenv</code> lets you easily switch between multiple versions of Python. It's simple, unobtrusive, and follows the UNIX tradition of single-purpose tools that do one thing well.
Visit the <a href="https://github.com/pyenv/pyenv"><code>pyenv</code> site</a> for instructions on how to install
and use <code>pyenv</code></p>
<h2 id="conda">Conda<a class="headerlink" href="#conda" title="Permanent link">&para;</a></h2>
<p>Conda is a convenient package manager and virtual environment.
The file <code>environment.yml</code> is a Conda environment file that you can use to create
a new Conda environment. Once created, you can simply activate this environment when
working with Bumble.<br />
working with Bumble.
Visit the <a href="https://docs.conda.io/en/latest/">Conda site</a> for instructions on how to install
and use Conda.
A few useful commands: </p>
A few useful commands:</p>
<h3 id="create-a-new-bumble-conda-environment">Create a new <code>bumble</code> Conda environment<a class="headerlink" href="#create-a-new-bumble-conda-environment" title="Permanent link">&para;</a></h3>
<p><div class="highlight"><pre><span></span><code>$ conda env create -f environment.yml
</code></pre></div>
@@ -1349,13 +1377,13 @@ This will create a new environment, named <code>bumble</code>, which you can the
</a>
<a href="../use_cases/index.html" title="Overview" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
<a href="contributing.html" title="Contributing" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
<span class="md-flex__ellipsis">
<span class="md-footer-nav__direction">
Next
</span>
Overview
Contributing
</span>
</div>
<div class="md-flex__cell md-flex__cell--shrink">