added installation guidelines

HimanshuLab · Mar 12, 2024 · 94958e2 · 94958e2
1 parent 0d7bc7b
commit 94958e2
Show file tree

Hide file tree

Showing 8 changed files with 26 additions and 17 deletions.
diff --git a/docs/img/conda_installation.png b/docs/img/conda_installation.png
diff --git a/docs/index.html b/docs/index.html
@@ -153,5 +153,5 @@ <h1 id="sci-vcf">SCI-VCF</h1>
 
 <!--
 MkDocs version : 1.4.2
-Build Date UTC : 2024-03-11 09:14:44.274898+00:00
+Build Date UTC : 2024-03-12 13:29:45.250295+00:00
 -->
diff --git a/docs/installation/index.html b/docs/installation/index.html
@@ -166,10 +166,13 @@ <h3 id="procedure_1">Procedure</h3>
 <p><strong>Step 4: Activate the conda environment created</strong></p>
 <pre><code>conda activate SCI-VCF
 </code></pre>
-<p><strong>Step 5: Open <code>global.R</code> from the <code>R</code> directory in RStudio</strong></p>
-<pre><code>rstudio R/global.R
+<p><strong>Step 5: Open <code>global.R</code> with R</strong></p>
+<pre><code>RScript R/global.R
 </code></pre>
-<p>Step 5: Launch SCI-VCF by clicking the <code>Run App</code> button.</p>
+<p>The following output will be printed</p>
+<p><img alt="conda_installation" src="../img/conda_installation.png" /></p>
+<p><strong>Step 6: Open SCI-VCF in a browser</strong></p>
+<p>Copy the IP address at the end of the CLI output from Step 5. Paste it in a browser search tab and load the same. SCI-VCF will be launched.</p>
 <p><em>Note: For conda-based installation in Windows OS, we recommend using the Windows Subsystem for Linux. More information is available in the <a href="../faq/">FAQ</a> section.</em></p>
 <h2 id="docker-based-installation">Docker-based installation</h2>
 <h3 id="prerequisites_2">Prerequisites</h3>

diff --git a/docs/search/search_index.json b/docs/search/search_index.json
diff --git a/docs/sitemap.xml b/docs/sitemap.xml
@@ -2,47 +2,47 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     <url>
          <loc>None</loc>
-         <lastmod>2024-03-11</lastmod>
+         <lastmod>2024-03-12</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2024-03-11</lastmod>
+         <lastmod>2024-03-12</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2024-03-11</lastmod>
+         <lastmod>2024-03-12</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2024-03-11</lastmod>
+         <lastmod>2024-03-12</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2024-03-11</lastmod>
+         <lastmod>2024-03-12</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2024-03-11</lastmod>
+         <lastmod>2024-03-12</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2024-03-11</lastmod>
+         <lastmod>2024-03-12</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2024-03-11</lastmod>
+         <lastmod>2024-03-12</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2024-03-11</lastmod>
+         <lastmod>2024-03-12</lastmod>
          <changefreq>daily</changefreq>
     </url>
 </urlset>
diff --git a/docs/sitemap.xml.gz b/docs/sitemap.xml.gz
diff --git a/mkdocs/docs/img/conda_installation.png b/mkdocs/docs/img/conda_installation.png
diff --git a/mkdocs/docs/installation.md b/mkdocs/docs/installation.md
@@ -72,13 +72,19 @@ conda env create -f conda/SCI-VCF_conda_env.yaml
 conda activate SCI-VCF
 ```
 
-**Step 5: Open ```global.R``` from the ```R``` directory in RStudio**
+**Step 5: Open ```global.R``` with R**
 ```
-rstudio R/global.R
+RScript R/global.R
 ```
 
-Step 5: Launch SCI-VCF by clicking the ```Run App``` button.
+The following output will be printed
 
+![conda_installation](img/conda_installation.png)
+
+
+**Step 6: Open SCI-VCF in a browser**
+
+Copy the IP address at the end of the CLI output from Step 5. Paste it in a browser search tab and load the same. SCI-VCF will be launched.
 
 *Note: For conda-based installation in Windows OS, we recommend using the Windows Subsystem for Linux. More information is available in the [FAQ](faq.md) section.*