deploy: e156482

_sources/installation.md.txt

@@ -5,6 +5,7 @@
 * If you are unfamiliar with the terminal, please review these [command line tutorials](https://andysbrainbook.readthedocs.io/en/latest/index.html)
 
 
+
 ## TL;DR
 * Activate a virtual environment in Python
 * Install UNRAVEL via [PyPI](https://pypi.org/project/heifetslab-unravel/):
@@ -15,6 +16,39 @@ pip install heifetslab-unravel
 * Install [Ilastik](https://www.ilastik.org/download.html)
 
 
+
+## Updating UNRAVEL
+
+To update UNRAVEL to the latest version, use the following command:
+
+```bash
+pip install --upgrade heifetslab-unravel
+```
+
+:::{admonition} Please note the version of UNRAVEL you are using for reproducibility.
+:class: note dropdown
+
+To check the installed version of UNRAVEL, use the following command:
+
+```bash
+pip show heifetslab-unravel
+
+```
+
+To check the latest version, go to the [heifetslab-unravel PyPI page](https://pypi.org/project/heifetslab-unravel/)
+:::
+
+:::{admonition} Checking changes between versions
+:class: note dropdown
+
+Releases and update notes for UNRAVEL can be found [here](https://github.com/b-heifets/UNRAVEL/releases) on GitHub .
+
+For more detailed information, you can view the commit history:
+* [Main branch commits](https://github.com/b-heifets/UNRAVEL/commits/main)
+* [Dev branch commits](https://github.com/b-heifets/UNRAVEL/commits/dev)
+:::
+
+
 ## Setting Up Windows Subsystem for Linux (WSL)
 
 1. **Install WSL:**
@@ -182,8 +216,5 @@ Apply the changes by restarting the terminal or source your shell configuration
     ```
 
 :::{note}
-To add extra depedencies (e.g., for updating documentation), run: 
-    ```bash
-    pip install -e ".[dev]"
-    ```
+To add extra depedencies (e.g., for updating documentation), run: ``pip install -e ".[dev]"``
 :::

index.html

@@ -455,6 +455,7 @@ <h2>Support is welcome for<a class="headerlink" href="#support-is-welcome-for" t
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="installation.html#tl-dr">TL;DR</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation.html#updating-unravel">Updating UNRAVEL</a></li>
 <li class="toctree-l2"><a class="reference internal" href="installation.html#setting-up-windows-subsystem-for-linux-wsl">Setting Up Windows Subsystem for Linux (WSL)</a></li>
 <li class="toctree-l2"><a class="reference internal" href="installation.html#installing-unravel-on-linux-or-wsl">Installing UNRAVEL on Linux or WSL</a></li>
 <li class="toctree-l2"><a class="reference internal" href="installation.html#edit-bashrc-or-zshrc-to-set-up-dependencies">Edit .bashrc or .zshrc to set up dependencies</a></li>

installation.html

@@ -379,6 +379,30 @@ <h2>TL;DR<a class="headerlink" href="#tl-dr" title="Link to this heading">#</a><
 <li><p>Install <a class="reference external" href="https://www.ilastik.org/download.html">Ilastik</a></p></li>
 </ul>
 </section>
+<section id="updating-unravel">
+<h2>Updating UNRAVEL<a class="headerlink" href="#updating-unravel" title="Link to this heading">#</a></h2>
+<p>To update UNRAVEL to the latest version, use the following command:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>--upgrade<span class="w"> </span>heifetslab-unravel
+</pre></div>
+</div>
+<div class="note dropdown admonition">
+<p class="admonition-title">Please note the version of UNRAVEL you are using for reproducibility.</p>
+<p>To check the installed version of UNRAVEL, use the following command:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>show<span class="w"> </span>heifetslab-unravel
+</pre></div>
+</div>
+<p>To check the latest version, go to the <a class="reference external" href="https://pypi.org/project/heifetslab-unravel/">heifetslab-unravel PyPI page</a></p>
+</div>
+<div class="note dropdown admonition">
+<p class="admonition-title">Checking changes between versions</p>
+<p>Releases and update notes for UNRAVEL can be found <a class="reference external" href="https://github.com/b-heifets/UNRAVEL/releases">here</a> on GitHub .</p>
+<p>For more detailed information, you can view the commit history:</p>
+<ul class="simple">
+<li><p><a class="reference external" href="https://github.com/b-heifets/UNRAVEL/commits/main">Main branch commits</a></p></li>
+<li><p><a class="reference external" href="https://github.com/b-heifets/UNRAVEL/commits/dev">Dev branch commits</a></p></li>
+</ul>
+</div>
+</section>
 <section id="setting-up-windows-subsystem-for-linux-wsl">
 <h2>Setting Up Windows Subsystem for Linux (WSL)<a class="headerlink" href="#setting-up-windows-subsystem-for-linux-wsl" title="Link to this heading">#</a></h2>
 <ol class="arabic">
@@ -553,8 +577,7 @@ <h2>Optional: editable installation of UNRAVEL<a class="headerlink" href="#optio
 </ol>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
-<p>To add extra depedencies (e.g., for updating documentation), run:
-<code class="docutils literal notranslate"><span class="pre">bash</span>&#160;&#160;&#160;&#160; <span class="pre">pip</span> <span class="pre">install</span> <span class="pre">-e</span> <span class="pre">&quot;.[dev]&quot;</span>&#160;&#160;&#160;&#160; </code></p>
+<p>To add extra depedencies (e.g., for updating documentation), run: <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">-e</span> <span class="pre">&quot;.[dev]&quot;</span></code></p>
 </div>
 </section>
 </section>
@@ -606,6 +629,7 @@ <h2>Optional: editable installation of UNRAVEL<a class="headerlink" href="#optio
   <nav class="bd-toc-nav page-toc" aria-labelledby="pst-page-navigation-heading-2">
     <ul class="visible nav section-nav flex-column">
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#tl-dr">TL;DR</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#updating-unravel">Updating UNRAVEL</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#setting-up-windows-subsystem-for-linux-wsl">Setting Up Windows Subsystem for Linux (WSL)</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#installing-unravel-on-linux-or-wsl">Installing UNRAVEL on Linux or WSL</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#edit-bashrc-or-zshrc-to-set-up-dependencies">Edit .bashrc or .zshrc to set up dependencies</a></li>