Skip to content

Commit 42bb1f0

Browse files
author
MFC Action
committed
Docs @ 93e3d09
1 parent 366bad8 commit 42bb1f0

File tree

85 files changed

+8904
-8812
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

85 files changed

+8904
-8812
lines changed

documentation/architecture.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -401,7 +401,7 @@ <h1 class="doxsection"><a class="anchor" id="autotoc_md13"></a>
401401
<li><b>Add the module to <span class="tt">docs/module_categories.json</span></b> so it appears in this page</li>
402402
</ol>
403403
<p>Follow the pattern of existing modules like <span class="tt">m_body_forces</span> (simple) or <span class="tt">m_viscous</span> (more involved) as a template.</p>
404-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-14</div> </div></div><!-- contents -->
404+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-15</div> </div></div><!-- contents -->
405405
</div><!-- PageDoc -->
406406
</div><!-- doc-content -->
407407
<div id="page-nav" class="page-nav-panel">

documentation/case_constraints.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1424,7 +1424,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
14241424
</table>
14251425
<hr />
14261426
<p>💡 <b>Tip:</b> If you encounter a validation error, check the relevant section above or review <a href="https://github.com/MFlowCode/MFC/blob/master/toolchain/mfc/case_validator.py"><span class="tt">case_validator.py</span></a> for complete validation logic.</p>
1427-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-14</div> </div></div><!-- contents -->
1427+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-15</div> </div></div><!-- contents -->
14281428
</div><!-- PageDoc -->
14291429
</div><!-- doc-content -->
14301430
<div id="page-nav" class="page-nav-panel">

documentation/cli-reference.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -727,20 +727,20 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md62"></a>
727727
Development Commands</h2>
728728
<h3 class="doxsection"><a class="anchor" id="lint"></a>
729729
lint</h3>
730-
<p>Run pylint and unit tests on MFC's toolchain Python code.</p>
730+
<p>Run ruff and unit tests on MFC's toolchain Python code.</p>
731731
<p><b>Usage:</b> <span class="tt">./mfc.sh lint [OPTIONS]</span></p>
732732
<p><b>Options:</b></p>
733733
<table class="markdownTable">
734734
<tr class="markdownTableHead">
735735
<th class="markdownTableHeadNone">Option </th><th class="markdownTableHeadNone">Description </th><th class="markdownTableHeadNone">Default </th></tr>
736736
<tr class="markdownTableRowOdd">
737-
<td class="markdownTableBodyNone"><span class="tt">--no-test</span> </td><td class="markdownTableBodyNone">Skip running unit tests (only run pylint). </td><td class="markdownTableBodyNone">- </td></tr>
737+
<td class="markdownTableBodyNone"><span class="tt">--no-test</span> </td><td class="markdownTableBodyNone">Skip running unit tests (only run ruff). </td><td class="markdownTableBodyNone">- </td></tr>
738738
</table>
739739
<p><b>Examples:</b></p>
740-
<div class="fragment"><div class="line"># Run pylint and unit tests</div>
740+
<div class="fragment"><div class="line"># Run ruff and unit tests</div>
741741
<div class="line">./mfc.sh lint</div>
742742
<div class="line"> </div>
743-
<div class="line"># Run only pylint (skip unit tests)</div>
743+
<div class="line"># Run only ruff (skip unit tests)</div>
744744
<div class="line">./mfc.sh lint --no-test</div>
745745
</div><!-- fragment --><hr />
746746
<h3 class="doxsection"><a class="anchor" id="format"></a>
@@ -952,7 +952,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md78"></a>
952952
<h3 class="doxsection"><a class="anchor" id="autotoc_md79"></a>
953953
Debug Logging (<span class="tt">-d, --debug-log</span>)</h3>
954954
<p>Enables debug logging for the Python toolchain (mfc.sh internals). This is for troubleshooting the build system, not the MFC simulation code.</p>
955-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-14</div> </div></div><!-- contents -->
955+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-15</div> </div></div><!-- contents -->
956956
</div><!-- PageDoc -->
957957
</div><!-- doc-content -->
958958
<div id="page-nav" class="page-nav-panel">

documentation/contributing.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -751,16 +751,17 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md114"></a>
751751
<p>Every push to a PR triggers CI. Understanding the pipeline helps you fix failures quickly.</p>
752752
<h3 class="doxsection"><a class="anchor" id="autotoc_md115"></a>
753753
Lint Gate (runs first, blocks all other jobs)</h3>
754-
<p>All four checks must pass before any builds start:</p>
754+
<p>All five checks must pass before any builds start:</p>
755755
<ol type="1">
756756
<li><b>Formatting</b><span class="tt">./mfc.sh format</span> (auto-handled by pre-commit hook)</li>
757757
<li><b>Spelling</b><span class="tt">./mfc.sh spelling</span></li>
758-
<li><b>Toolchain lint</b><span class="tt">./mfc.sh lint</span> (Python code quality)</li>
758+
<li><b>Toolchain lint</b><span class="tt">./mfc.sh lint</span> (ruff + Python unit tests)</li>
759759
<li><b>Source lint</b> — checks for:<ul>
760760
<li>Raw <span class="tt">!$acc</span> or <span class="tt">!$omp</span> directives (must use Fypp GPU macros)</li>
761761
<li>Double-precision intrinsics (<span class="tt">dsqrt</span>, <span class="tt">dexp</span>, <span class="tt">dble</span>, etc.)</li>
762762
</ul>
763763
</li>
764+
<li><b>Doc references</b> — validates documentation cross-references</li>
764765
</ol>
765766
<h3 class="doxsection"><a class="anchor" id="autotoc_md116"></a>
766767
Build and Test Matrix</h3>

documentation/examples.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -388,7 +388,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md273"></a>
388388
<h3 class="doxsection"><a class="anchor" id="autotoc_md274"></a>
389389
Final Condition (Density)</h3>
390390
<p><img src="final-2D_forward_facing_step-example.png" alt="" class="inline"/></p>
391-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-14</div> </div></div><!-- contents -->
391+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-15</div> </div></div><!-- contents -->
392392
</div><!-- PageDoc -->
393393
</div><!-- doc-content -->
394394
<div id="page-nav" class="page-nav-panel">

documentation/parameters.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1566,7 +1566,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md393"></a>
15661566
<div class="line"> </div>
15671567
<div class="line"># Filter by type</div>
15681568
<div class="line">./mfc.sh params -t real weno</div>
1569-
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-14</div> </div></div><!-- contents -->
1569+
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-15</div> </div></div><!-- contents -->
15701570
</div><!-- PageDoc -->
15711571
</div><!-- doc-content -->
15721572
<div id="page-nav" class="page-nav-panel">

documentation/physics_constraints.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -623,7 +623,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md443"></a>
623623
<li>FFT WRT incompatible with cylindrical coordinates</li>
624624
<li>FFT WRT requires global dimensions divisible by 2</li>
625625
</ul>
626-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-14</div> </div></div><!-- contents -->
626+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-15</div> </div></div><!-- contents -->
627627
</div><!-- PageDoc -->
628628
</div><!-- doc-content -->
629629
<div id="page-nav" class="page-nav-panel">

0 commit comments

Comments
 (0)