Skip to content

Commit

Permalink
Built site for gh-pages
Browse files Browse the repository at this point in the history
  • Loading branch information
Quarto GHA Workflow Runner committed Oct 27, 2023
1 parent d6ebe8d commit 5125d85
Show file tree
Hide file tree
Showing 12 changed files with 2,771 additions and 162 deletions.
2 changes: 1 addition & 1 deletion .nojekyll
Original file line number Diff line number Diff line change
@@ -1 +1 @@
81a2d6b4
b78f5444
246 changes: 123 additions & 123 deletions build/index.html

Large diffs are not rendered by default.

21 changes: 4 additions & 17 deletions contribute/addnode.html
Original file line number Diff line number Diff line change
Expand Up @@ -443,29 +443,16 @@ <h1 data-number="6"><span class="header-section-number">6</span> Documentation</
<li><code>docs/core/equations</code> should contain a short explanation and if possible an analytical expression for the behaviour of the new node;</li>
<li><code>docs/core/usage.qmd</code> should contain a short explanation of the node and the possible schemas associated with it;</li>
<li>The example models constructed in <code>docs/python/examples.ipynb</code> should be extended with the new node type or a new example model with the new node type should be made.</li>
<li>In <code>_quarto.yml</code> add <code>NewNodeType</code> to the “Node types” contents for the Python API reference.</li>
</ul>
</section>
<section id="finishing-up" class="level1" data-number="7">
<h1 data-number="7"><span class="header-section-number">7</span> Finishing up</h1>
<p>When a new node type is created, one needs to run</p>
<pre><code>julia --project=docs docs/gen_schema.jl</code></pre>
<p>to create new JSON Schemas in the docs folder.</p>
<div class="callout callout-style-default callout-note callout-titled">
<div class="callout-header d-flex align-content-center">
<div class="callout-icon-container">
<i class="callout-icon"></i>
</div>
<div class="callout-title-container flex-fill">
Note
</div>
</div>
<div class="callout-body-container callout-body">
<p>If you haven’t done so before, you first need to instantiate your docs environment. Run <code>julia --project=docs</code>, followed by running <code>instantiate</code> in the Pkg mode (press <code>]</code>).</p>
</div>
</div>
<p>To generate the Python module <code>models.py</code> and <code>config.py</code> from the JSON Schemas, run:</p>
<pre><code>pixi run codegen</code></pre>
<p>Since adding a node type touches both the Python and Julia code, it is a good idea to run both the <a href="../contribute/python.html#test">Python test suite</a> and <a href="../contribute/core.html#test">Julia test suite</a> locally before creating a pull request.</p>
<p>This will derive all JSON Schemas from the julia code, and write them to the docs folder. From these JSON Schemas the Python modules <code>models.py</code> and <code>config.py</code> are generated.</p>
<p>Since adding a node type touches both the Python and Julia code, it is a good idea to run both the <a href="../contribute/python.html#test">Python test suite</a> and <a href="../contribute/core.html#test">Julia test suite</a> locally before creating a pull request. You can run all tests with:</p>
<pre><code>pixi run tests</code></pre>


</section>
Expand Down
2 changes: 1 addition & 1 deletion python/examples.html
Original file line number Diff line number Diff line change
Expand Up @@ -545,7 +545,7 @@ <h1 data-number="2"><span class="header-section-number">2</span> Update the basi
<span id="cb26-4"><a href="#cb26-4" aria-hidden="true" tabindex="-1"></a>ax <span class="op">=</span> df_flow.pivot_table(index<span class="op">=</span><span class="st">"time"</span>, columns<span class="op">=</span><span class="st">"edge"</span>, values<span class="op">=</span><span class="st">"flow_m3d"</span>).plot()</span>
<span id="cb26-5"><a href="#cb26-5" aria-hidden="true" tabindex="-1"></a>ax.legend(bbox_to_anchor<span class="op">=</span>(<span class="fl">1.3</span>, <span class="dv">1</span>), title<span class="op">=</span><span class="st">"Edge"</span>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="cell-output cell-output-display" data-execution_count="26">
<pre><code>&lt;matplotlib.legend.Legend at 0x7fad4ca40c10&gt;</code></pre>
<pre><code>&lt;matplotlib.legend.Legend at 0x7f68fc3b1490&gt;</code></pre>
</div>
<div class="cell-output cell-output-display">
<p><img src="examples_files/figure-html/cell-27-output-2.png" width="727" height="561"></p>
Expand Down
Loading

0 comments on commit 5125d85

Please sign in to comment.