Deployed 5c1cb84 with MkDocs version: 1.5.3

index.html

@@ -180,5 +180,5 @@ <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
 
 <!--
 MkDocs version : 1.5.3
-Build Date UTC : 2024-03-12 16:09:55.418909+00:00
+Build Date UTC : 2024-03-12 17:54:17.836327+00:00
 -->

setup/index.html

@@ -131,6 +131,9 @@ <h1 id="setup">Setup<a class="headerlink" href="#setup" title="Permanent link">&
 <p>To set up the automatic linters (that run every time you commit your work), you would run:<br />
 <code>pixi run pre-commit install</code></p>
 <p><img alt="install_pre_commit" src="../images/install_pre_commit.png" /></p>
+<p>Finish the installation proces with:<br />
+<code>pixi run pip install -e .</code></p>
+<p>If you skip this last step, you will <strong>not</strong> be able to import <code>icedyno</code> as an installed python library. </p>
 <h2 id="testing-the-set-up">Testing the set up<a class="headerlink" href="#testing-the-set-up" title="Permanent link">&para;</a></h2>
 <p>If you activated the pixi environment, type <code>pytest</code>. If not, type <code>pixi run pytest</code>. You should have one dummy test that runs on that command.</p>
 <h2 id="what-does-it-look-like-when-the-linters-and-pre-commit-hooks-run">What does it look like when the linters and pre-commit hooks run?<a class="headerlink" href="#what-does-it-look-like-when-the-linters-and-pre-commit-hooks-run" title="Permanent link">&para;</a></h2>

workflow/index.html

@@ -81,6 +81,10 @@
 
             <li class="nav-item" data-level="1"><a href="#icedyno-dev-workflow" class="nav-link">IceDyno Dev Workflow</a>
               <ul class="nav flex-column">
+            <li class="nav-item" data-level="2"><a href="#resolving-rebase-conflicts-with-pixilock" class="nav-link">Resolving rebase conflicts with pixi.lock</a>
+              <ul class="nav flex-column">
+              </ul>
+            </li>
               </ul>
             </li>
         </ul>
@@ -89,7 +93,10 @@
                     <div class="col-md-9" role="main">
 
 <h1 id="icedyno-dev-workflow">IceDyno Dev Workflow<a class="headerlink" href="#icedyno-dev-workflow" title="Permanent link">&para;</a></h1>
-<p>This is where we should document how we should merge/rebase/squash/etc and things we should know while working.</p></div>
+<p>This is where we should document how we should merge/rebase/squash/etc and things we should know while working.</p>
+<h2 id="resolving-rebase-conflicts-with-pixilock">Resolving rebase conflicts with pixi.lock<a class="headerlink" href="#resolving-rebase-conflicts-with-pixilock" title="Permanent link">&para;</a></h2>
+<p>You will only enounter this if you have added/removed dependencies and main has received commits since you first branched that included new/removed dependencies.</p>
+<p>If you encounter this, please make sure that the pixi.toml contains the (non-duplicated) additions from your commits and main's, then delete the pixi.lock and run <code>pixi install</code> to regnerate the lock file given both sets of dependencies.</p></div>
             </div>
         </div>