Docs with installation updated

carlesperez94 · Apr 29, 2020 · b73b1c0 · b73b1c0
1 parent 9c1088f
commit b73b1c0
Show file tree

Hide file tree

Showing 7 changed files with 53 additions and 9 deletions.
diff --git a/docs/_build/.doctrees/environment.pickle b/docs/_build/.doctrees/environment.pickle
diff --git a/docs/_build/.doctrees/installation.doctree b/docs/_build/.doctrees/installation.doctree
diff --git a/docs/_build/_sources/installation.rst.txt b/docs/_build/_sources/installation.rst.txt
@@ -12,8 +12,15 @@ Installation
 Conda (Recommended)
 -------------------
 
-TODO
+Conda installation commands::
+
+    conda create -n libprep python=3.7
+    conda activate libprep
+    conda install -c NostrumBioDiscovery
 
+Once you have the conda environment created, you just need to activate it to use lib_prep::
+    
+    conda activate libprep
 
 Pypi
 ----
@@ -28,4 +35,6 @@ TODO
 Test
 ----
 
-TODO
+Test LibPrep through pytest module::
+    cd tests/
+    python -m pytest test_all.py
diff --git a/docs/_build/installation.html b/docs/_build/installation.html
@@ -175,7 +175,16 @@ <h1>Installation<a class="headerlink" href="#installation" title="Permalink to t
 </div>
 <div class="section" id="conda-recommended">
 <h2>Conda (Recommended)<a class="headerlink" href="#conda-recommended" title="Permalink to this headline">¶</a></h2>
-<p>TODO</p>
+<p>Conda installation commands:</p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">create</span> <span class="o">-</span><span class="n">n</span> <span class="n">libprep</span> <span class="n">python</span><span class="o">=</span><span class="mf">3.7</span>
+<span class="n">conda</span> <span class="n">activate</span> <span class="n">libprep</span>
+<span class="n">conda</span> <span class="n">install</span> <span class="o">-</span><span class="n">c</span> <span class="n">NostrumBioDiscovery</span>
+</pre></div>
+</div>
+<p>Once you have the conda environment created, you just need to activate it to use lib_prep:</p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">activate</span> <span class="n">libprep</span>
+</pre></div>
+</div>
 </div>
 <div class="section" id="pypi">
 <h2>Pypi<a class="headerlink" href="#pypi" title="Permalink to this headline">¶</a></h2>
@@ -187,7 +196,11 @@ <h2>Source code<a class="headerlink" href="#source-code" title="Permalink to thi
 </div>
 <div class="section" id="test">
 <h2>Test<a class="headerlink" href="#test" title="Permalink to this headline">¶</a></h2>
-<p>TODO</p>
+<dl class="docutils">
+<dt>Test LibPrep through pytest module::</dt>
+<dd>cd tests/
+python -m pytest test_all.py</dd>
+</dl>
 </div>
 </div>
 

diff --git a/docs/_build/searchindex.js b/docs/_build/searchindex.js
diff --git a/docs/_source/installation.rst b/docs/_source/installation.rst
@@ -12,8 +12,15 @@ Installation
 Conda (Recommended)
 -------------------
 
-TODO
+Conda installation commands::
+
+    conda create -n libprep python=3.7
+    conda activate libprep
+    conda install -c NostrumBioDiscovery
 
+Once you have the conda environment created, you just need to activate it to use lib_prep::
+    
+    conda activate libprep
 
 Pypi
 ----
@@ -28,4 +35,6 @@ TODO
 Test
 ----
 
-TODO
+Test LibPrep through pytest module::
+    cd tests/
+    python -m pytest test_all.py
diff --git a/docs/installation.html b/docs/installation.html
@@ -175,7 +175,16 @@ <h1>Installation<a class="headerlink" href="#installation" title="Permalink to t
 </div>
 <div class="section" id="conda-recommended">
 <h2>Conda (Recommended)<a class="headerlink" href="#conda-recommended" title="Permalink to this headline">¶</a></h2>
-<p>TODO</p>
+<p>Conda installation commands:</p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">create</span> <span class="o">-</span><span class="n">n</span> <span class="n">libprep</span> <span class="n">python</span><span class="o">=</span><span class="mf">3.7</span>
+<span class="n">conda</span> <span class="n">activate</span> <span class="n">libprep</span>
+<span class="n">conda</span> <span class="n">install</span> <span class="o">-</span><span class="n">c</span> <span class="n">NostrumBioDiscovery</span>
+</pre></div>
+</div>
+<p>Once you have the conda environment created, you just need to activate it to use lib_prep:</p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">activate</span> <span class="n">libprep</span>
+</pre></div>
+</div>
 </div>
 <div class="section" id="pypi">
 <h2>Pypi<a class="headerlink" href="#pypi" title="Permalink to this headline">¶</a></h2>
@@ -187,7 +196,11 @@ <h2>Source code<a class="headerlink" href="#source-code" title="Permalink to thi
 </div>
 <div class="section" id="test">
 <h2>Test<a class="headerlink" href="#test" title="Permalink to this headline">¶</a></h2>
-<p>TODO</p>
+<dl class="docutils">
+<dt>Test LibPrep through pytest module::</dt>
+<dd>cd tests/
+python -m pytest test_all.py</dd>
+</dl>
 </div>
 </div>