Skip to content

Commit 6e790d5

Browse files
committed
update docs
1 parent 205493d commit 6e790d5

File tree

3 files changed

+5
-40
lines changed

3 files changed

+5
-40
lines changed

docs/latest/_sources/usage.rst.txt

+2-24
Original file line numberDiff line numberDiff line change
@@ -8,30 +8,8 @@ Usage
88
Installation
99
------------
1010

11-
To use LLaMBDA, we recommend you first create an isolated environment with python 3.9 (or higher):
11+
We recommend creating a new virtual environment using venv before installing LLaMBDA. To do so, please follow instructions [here](https://docs.python.org/3/library/venv.html).
1212

1313
.. code-block:: console
1414
15-
conda create python=3.9 --name llambda-env
16-
17-
18-
Activate the new environment before installing `llambda`.
19-
20-
.. code-block:: console
21-
22-
conda activate llambda-env
23-
24-
The shell should now look like `(llambda-env) $`.
25-
26-
Install LLaMBDA using pip directly from the GitHub repository.
27-
28-
.. code-block:: console
29-
30-
(llambda-env) $ pip install --user git+https://github.com/cvs-health/llambda.git
31-
32-
33-
If you would like to access your virtual env from a notebook, install it as a Jupyter kernel:
34-
35-
.. code-block:: console
36-
37-
python kernel install --name "llambda-env" --user
15+
pip install git+https://github.com/cvs-health/llambda.git

docs/latest/searchindex.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/latest/usage.html

+2-15
Original file line numberDiff line numberDiff line change
@@ -369,21 +369,8 @@
369369
<h1>Usage<a class="headerlink" href="#usage" title="Link to this heading">#</a></h1>
370370
<section id="gettingstarted">
371371
<span id="installation"></span><span id="id1"></span><h2>Installation<a class="headerlink" href="#gettingstarted" title="Link to this heading">#</a></h2>
372-
<p>To use LLaMBDA, we recommend you first create an isolated environment with python 3.9 (or higher):</p>
373-
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">conda create python=3.9 --name llambda-env</span>
374-
</pre></div>
375-
</div>
376-
<p>Activate the new environment before installing <cite>llambda</cite>.</p>
377-
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">conda activate llambda-env</span>
378-
</pre></div>
379-
</div>
380-
<p>The shell should now look like <cite>(llambda-env) $</cite>.</p>
381-
<p>Install LLaMBDA using pip directly from the GitHub repository.</p>
382-
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp gp-VirtualEnv">(llambda-env)</span> <span class="gp">$ </span>pip<span class="w"> </span>install<span class="w"> </span>--user<span class="w"> </span>git+https://github.com/cvs-health/llambda.git
383-
</pre></div>
384-
</div>
385-
<p>If you would like to access your virtual env from a notebook, install it as a Jupyter kernel:</p>
386-
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">python kernel install --name &quot;llambda-env&quot; --user</span>
372+
<p>We recommend creating a new virtual environment using venv before installing LLaMBDA. To do so, please follow instructions [here](<a class="reference external" href="https://docs.python.org/3/library/venv.html">https://docs.python.org/3/library/venv.html</a>).</p>
373+
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">pip install git+https://github.com/cvs-health/llambda.git</span>
387374
</pre></div>
388375
</div>
389376
</section>

0 commit comments

Comments
 (0)