Skip to content

Commit c47e5aa

Browse files
sorenwackersorenwacker
committed
deploy: 5cfe799 
1 parent ab87316 commit c47e5aa

8 files changed

Lines changed: 9175 additions & 3209 deletions

File tree

‎api_reference/core/index.html‎

Lines changed: 7313 additions & 2389 deletions
Large diffs are not rendered by default.

‎api_reference/visualization/index.html‎

Lines changed: 1776 additions & 800 deletions
Large diffs are not rendered by default.

‎index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -917,7 +917,7 @@ <h2 id="quick-links">Quick Links<a class="headerlink" href="#quick-links" title=
917917
<ul>
918918
<li><strong><a href="https://lewisresearchgroup.github.io/ms-mint">Python Library Documentation</a></strong> - Core ms-mint library for scripts and notebooks</li>
919919
<li><strong><a href="https://lewisresearchgroup.github.io/ms-mint-app">Web Application Documentation</a></strong> - Browser-based MINT interface</li>
920-
<li><strong><a href="https://drive.google.com/drive/folders/1U4xMy5lfETk93sSVXPI79cCWyIMcAjeZ?usp=drive_link">Demo Data</a></strong> - Download test data with sample LC-MS files and target lists</li>
920+
<li><strong><a href="https://zenodo.org/records/17727891">Demo Data</a></strong> - Download test data with sample LC-MS files and target lists</li>
921921
</ul>
922922
<h2 id="resources">Resources<a class="headerlink" href="#resources" title="Permanent link">&para;</a></h2>
923923
<ul>

‎installation/index.html‎

Lines changed: 70 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -309,6 +309,19 @@
309309

310310

311311

312+
<label class="md-nav__link md-nav__link--active" for="__toc">
313+
314+
315+
316+
<span class="md-ellipsis">
317+
Installation
318+
319+
</span>
320+
321+
322+
<span class="md-nav__icon md-icon"></span>
323+
</label>
324+
312325
<a href="./" class="md-nav__link md-nav__link--active">
313326

314327

@@ -321,6 +334,52 @@
321334

322335
</a>
323336

337+
338+
339+
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
340+
341+
342+
343+
344+
345+
346+
<label class="md-nav__title" for="__toc">
347+
<span class="md-nav__icon md-icon"></span>
348+
Table of contents
349+
</label>
350+
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
351+
352+
<li class="md-nav__item">
353+
<a href="#optional-gui-support" class="md-nav__link">
354+
<span class="md-ellipsis">
355+
Optional: GUI Support
356+
</span>
357+
</a>
358+
359+
</li>
360+
361+
<li class="md-nav__item">
362+
<a href="#development-version" class="md-nav__link">
363+
<span class="md-ellipsis">
364+
Development Version
365+
</span>
366+
</a>
367+
368+
</li>
369+
370+
<li class="md-nav__item">
371+
<a href="#notes" class="md-nav__link">
372+
<span class="md-ellipsis">
373+
Notes
374+
</span>
375+
</a>
376+
377+
</li>
378+
379+
</ul>
380+
381+
</nav>
382+
324383
</li>
325384

326385

@@ -730,14 +789,21 @@ <h1 id="installation">Installation<a class="headerlink" href="#installation" tit
730789
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>pip<span class="w"> </span>install<span class="w"> </span>ms-mint
731790
</code></pre></div>
732791
<p>This will install the core library for use in scripts, notebooks, or other Python-based workflows.</p>
733-
<blockquote>
734-
<p><strong>Note:</strong> As of version <code>1.0.0</code>, ms-mint uses <a href="https://peps.python.org/pep-0621/">PEP 621</a> standards via <code>pyproject.toml</code> for packaging. If you plan to install from source or contribute, ensure you have an up-to-date version of <code>pip</code>, <code>setuptools</code>, and <code>build</code> installed:</p>
735-
</blockquote>
736-
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>pip<span class="w"> </span>install<span class="w"> </span>--upgrade<span class="w"> </span>pip<span class="w"> </span>setuptools<span class="w"> </span>build
792+
<h2 id="optional-gui-support">Optional: GUI Support<a class="headerlink" href="#optional-gui-support" title="Permanent link">&para;</a></h2>
793+
<p>To include the Solara-based interactive GUI for Jupyter notebooks:</p>
794+
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>pip<span class="w"> </span>install<span class="w"> </span>ms-mint<span class="o">[</span>gui<span class="o">]</span>
737795
</code></pre></div>
796+
<h2 id="development-version">Development Version<a class="headerlink" href="#development-version" title="Permanent link">&para;</a></h2>
738797
<p>To install the latest development version directly from GitHub:</p>
739798
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>pip<span class="w"> </span>install<span class="w"> </span>git+https://github.com/LewisResearchGroup/ms-mint.git
740799
</code></pre></div>
800+
<p>Or with GUI support:</p>
801+
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>pip<span class="w"> </span>install<span class="w"> </span><span class="s2">&quot;ms-mint[gui] @ git+https://github.com/LewisResearchGroup/ms-mint.git&quot;</span>
802+
</code></pre></div>
803+
<h2 id="notes">Notes<a class="headerlink" href="#notes" title="Permanent link">&para;</a></h2>
804+
<p>As of version <code>1.0.0</code>, ms-mint uses <a href="https://peps.python.org/pep-0621/">PEP 621</a> standards via <code>pyproject.toml</code> for packaging. If you plan to install from source or contribute, ensure you have an up-to-date version of <code>pip</code>, <code>setuptools</code>, and <code>build</code> installed:</p>
805+
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>pip<span class="w"> </span>install<span class="w"> </span>--upgrade<span class="w"> </span>pip<span class="w"> </span>setuptools<span class="w"> </span>build
806+
</code></pre></div>
741807
<p>For most users, the PyPI version is sufficient and recommended.</p>
742808

743809

‎objects.inv‎

114 Bytes
Binary file not shown.

‎search/search_index.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎sitemap.xml‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,58 +2,58 @@
22
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
33
<url>
44
<loc>https://lewisresearchgroup.github.io/ms-mint/</loc>
5-
<lastmod>2025-11-03</lastmod>
5+
<lastmod>2025-11-27</lastmod>
66
</url>
77
<url>
88
<loc>https://lewisresearchgroup.github.io/ms-mint/installation/</loc>
9-
<lastmod>2025-11-03</lastmod>
9+
<lastmod>2025-11-27</lastmod>
1010
</url>
1111
<url>
1212
<loc>https://lewisresearchgroup.github.io/ms-mint/quickstart/</loc>
13-
<lastmod>2025-11-03</lastmod>
13+
<lastmod>2025-11-27</lastmod>
1414
</url>
1515
<url>
1616
<loc>https://lewisresearchgroup.github.io/ms-mint/api_reference/</loc>
17-
<lastmod>2025-11-03</lastmod>
17+
<lastmod>2025-11-27</lastmod>
1818
</url>
1919
<url>
2020
<loc>https://lewisresearchgroup.github.io/ms-mint/api_reference/core/</loc>
21-
<lastmod>2025-11-03</lastmod>
21+
<lastmod>2025-11-27</lastmod>
2222
</url>
2323
<url>
2424
<loc>https://lewisresearchgroup.github.io/ms-mint/api_reference/io/</loc>
25-
<lastmod>2025-11-03</lastmod>
25+
<lastmod>2025-11-27</lastmod>
2626
</url>
2727
<url>
2828
<loc>https://lewisresearchgroup.github.io/ms-mint/api_reference/processing/</loc>
29-
<lastmod>2025-11-03</lastmod>
29+
<lastmod>2025-11-27</lastmod>
3030
</url>
3131
<url>
3232
<loc>https://lewisresearchgroup.github.io/ms-mint/api_reference/targets/</loc>
33-
<lastmod>2025-11-03</lastmod>
33+
<lastmod>2025-11-27</lastmod>
3434
</url>
3535
<url>
3636
<loc>https://lewisresearchgroup.github.io/ms-mint/api_reference/tools/</loc>
37-
<lastmod>2025-11-03</lastmod>
37+
<lastmod>2025-11-27</lastmod>
3838
</url>
3939
<url>
4040
<loc>https://lewisresearchgroup.github.io/ms-mint/api_reference/visualization/</loc>
41-
<lastmod>2025-11-03</lastmod>
41+
<lastmod>2025-11-27</lastmod>
4242
</url>
4343
<url>
4444
<loc>https://lewisresearchgroup.github.io/ms-mint/user_guide/</loc>
45-
<lastmod>2025-11-03</lastmod>
45+
<lastmod>2025-11-27</lastmod>
4646
</url>
4747
<url>
4848
<loc>https://lewisresearchgroup.github.io/ms-mint/user_guide/file_formats/</loc>
49-
<lastmod>2025-11-03</lastmod>
49+
<lastmod>2025-11-27</lastmod>
5050
</url>
5151
<url>
5252
<loc>https://lewisresearchgroup.github.io/ms-mint/user_guide/target_lists/</loc>
53-
<lastmod>2025-11-03</lastmod>
53+
<lastmod>2025-11-27</lastmod>
5454
</url>
5555
<url>
5656
<loc>https://lewisresearchgroup.github.io/ms-mint/user_guide/visualization/</loc>
57-
<lastmod>2025-11-03</lastmod>
57+
<lastmod>2025-11-27</lastmod>
5858
</url>
5959
</urlset>

‎sitemap.xml.gz‎

0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)