Skip to content

Commit

Permalink
fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ovitrac committed Feb 27, 2025
1 parent d350015 commit c4fdfd8
Show file tree
Hide file tree
Showing 10 changed files with 15 additions and 15 deletions.
6 changes: 3 additions & 3 deletions docs/SFPPy_classes_documentation.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# SFPPy Modules Documentation

Generated on: **2025-02-27 14:44:38**
Generated on: **2025-02-27 15:44:53**

<hr style="border: none; height: 1px; background-color: #e0e0e0;" />


## **Running SFPPy**

> **SFPPy** enables the **compliance assessment of food contact materials** and facilitates **risk assessments** through **migration modeling**.
> The term *"[Migration Modeling]("./MigrationModeling/")"* refers to the **simulation of mass transfer** (primarily diffusive) from packaging materials into food.
> The term *"[Migration Modeling]("MigrationModeling/")"* refers to the **simulation of mass transfer** (primarily diffusive) from packaging materials into food.
#### **What this guide covers:**
1. **Running SFPPy/example1.py** (or `example2.py`, `example3.py`) immediately after cloning the repository.
Expand All @@ -22,7 +22,7 @@ For the best experience, we recommend using [Jupyter](https://docs.jupyter.org/e
### **📌 Prerequisites**
Before running SFPPy, make sure you have:

**A basic understanding of Migration Modeling** → Read this [document]("./MigrationModeling/").
**A basic understanding of Migration Modeling** → Read this [document]("MigrationModeling/").
**Python 3.x (≥3.8) installed**.
**Dependencies installed**:
- If your Python distribution does **not include scientific libraries** (NumPy, SciPy, Matplotlib, Pandas), install them using:
Expand Down
2 changes: 1 addition & 1 deletion docs/class_examples.html
Original file line number Diff line number Diff line change
Expand Up @@ -336,7 +336,7 @@ <h2>Welcome to Usage Class Examples</h2>
<p>Select a module in the left menu to view usage examples. These examples are not for production and are automatically extracted from the main section of each module.</p>
<p>Back to the <a href='index.html'>Python'SFPPy documentation</a>.</p>
<p>When no module is selected, you see this welcome page. They are used to test classes with typical codes. The main section often serves as a testing script, example usage block, or self-contained test block. It's a way to demonstrate how the module's functionality works or to run simple unit tests and examples inline.</p>
<p>Generated on: 2025-02-27 14:44:38</p>
<p>Generated on: 2025-02-27 15:44:53</p>

</div>

Expand Down
8 changes: 4 additions & 4 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -303,7 +303,7 @@
<div id="notification-banner" class="notification-banner">
<span>
If you are looking for the concepts of migration modeling and risk assessment, please follow this
<a href="./MigrationModeling/" target="_book">link</a>.
<a href="MigrationModeling/" target="_book">link</a>.
</span>
<button class="close-button" onclick="closeBanner()">&times;</button>
</div>
Expand Down Expand Up @@ -371,15 +371,15 @@ <h2>Welcome to SFPPy Documentation</h2>
const markdownContent = `
# SFPPy Modules Documentation
Generated on: **2025-02-27 14:44:38**
Generated on: **2025-02-27 15:44:53**
<hr style="border: none; height: 1px; background-color: #e0e0e0;" />
## **Running SFPPy**
> **SFPPy** enables the **compliance assessment of food contact materials** and facilitates **risk assessments** through **migration modeling**.
> The term *"[Migration Modeling]("./MigrationModeling/")"* refers to the **simulation of mass transfer** (primarily diffusive) from packaging materials into food.
> The term *"[Migration Modeling]("MigrationModeling/")"* refers to the **simulation of mass transfer** (primarily diffusive) from packaging materials into food.
#### **What this guide covers:**
1. **Running SFPPy/example1.py** (or \`example2.py\`, \`example3.py\`) immediately after cloning the repository.
Expand All @@ -393,7 +393,7 @@ <h2>Welcome to SFPPy Documentation</h2>
### **📌 Prerequisites**
Before running SFPPy, make sure you have:
✅ **A basic understanding of Migration Modeling** → Read this [document]("./MigrationModeling/").
✅ **A basic understanding of Migration Modeling** → Read this [document]("MigrationModeling/").
✅ **Python 3.x (≥3.8) installed**.
✅ **Dependencies installed**:
- If your Python distribution does **not include scientific libraries** (NumPy, SciPy, Matplotlib, Pandas), install them using:
Expand Down
2 changes: 1 addition & 1 deletion docs/index_matlab.html
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ <h2>Welcome to Pizza3 Matlab Documentation</h2>
<p>Back to the <a href='index.html'>Python'Pizza3 documentation</a>.</p>
<hr>
<p><i>When no function is selected, you see this welcome page.</i></p>
Generated on: 2025-02-27 14:44:37</div>
Generated on: 2025-02-27 15:44:53</div>
<div id='testcase' class='doc-content' style='display: none;'>
<h1>reference system</h1>
<button class="collapsible">Show MATLAB Code</button>
Expand Down
2 changes: 1 addition & 1 deletion docs/patankar/migration.html
Original file line number Diff line number Diff line change
Expand Up @@ -2498,7 +2498,7 @@ <h2 id="returns">Returns</h2>
</details>
</dd>
<dt id="migration.senspatankar"><code class="name flex">
<span>def <span class="ident">senspatankar</span></span>(<span>multilayer=None, medium=None, name='senspatantkar:9HhMmN', description='', t=None, autotime=True, timescale='sqrt', Cxprevious=None, ntimes=1000.0, RelTol=1e-06, AbsTol=1e-06)</span>
<span>def <span class="ident">senspatankar</span></span>(<span>multilayer=None, medium=None, name='senspatantkar:y1fCdu', description='', t=None, autotime=True, timescale='sqrt', Cxprevious=None, ntimes=1000.0, RelTol=1e-06, AbsTol=1e-06)</span>
</code></dt>
<dd>
<div class="desc"><p>Simulates in 1D the mass transfer of a substance initially distributed in a multilayer
Expand Down
2 changes: 1 addition & 1 deletion docs/patankar/migration.html~
Original file line number Diff line number Diff line change
Expand Up @@ -2498,7 +2498,7 @@ Cfull_dimless (np.ndarray): Full concentration profile.</p></div>
</details>
</dd>
<dt id="migration.senspatankar"><code class="name flex">
<span>def <span class="ident">senspatankar</span></span>(<span>multilayer=None, medium=None, name='senspatantkar:9HhMmN', description='', t=None, autotime=True, timescale='sqrt', Cxprevious=None, ntimes=1000.0, RelTol=1e-06, AbsTol=1e-06)</span>
<span>def <span class="ident">senspatankar</span></span>(<span>multilayer=None, medium=None, name='senspatantkar:y1fCdu', description='', t=None, autotime=True, timescale='sqrt', Cxprevious=None, ntimes=1000.0, RelTol=1e-06, AbsTol=1e-06)</span>
</code></dt>
<dd>
<div class="desc"><p>Simulates in 1D the mass transfer of a substance initially distributed in a multilayer
Expand Down
2 changes: 1 addition & 1 deletion docs/patankar/private/chemspipy/api.html
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@
<div style="border: 2px solid red; padding: 10px; margin-bottom: 20px;">
<h3 style="color: red;">Notice</h3>
<p>This is a raw view of the Python source code due to an error in generating the documentation.</p>
<p><strong>Date of Conversion:</strong> 2025-02-27 14:45:04</p>
<p><strong>Date of Conversion:</strong> 2025-02-27 15:45:19</p>
</div>

<h2></h2>
Expand Down
2 changes: 1 addition & 1 deletion docs/patankar/private/chemspipy/objects.html
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@
<div style="border: 2px solid red; padding: 10px; margin-bottom: 20px;">
<h3 style="color: red;">Notice</h3>
<p>This is a raw view of the Python source code due to an error in generating the documentation.</p>
<p><strong>Date of Conversion:</strong> 2025-02-27 14:45:04</p>
<p><strong>Date of Conversion:</strong> 2025-02-27 15:45:19</p>
</div>

<h2></h2>
Expand Down
2 changes: 1 addition & 1 deletion docs/patankar/private/chemspipy/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@
<div style="border: 2px solid red; padding: 10px; margin-bottom: 20px;">
<h3 style="color: red;">Notice</h3>
<p>This is a raw view of the Python source code due to an error in generating the documentation.</p>
<p><strong>Date of Conversion:</strong> 2025-02-27 14:45:04</p>
<p><strong>Date of Conversion:</strong> 2025-02-27 15:45:19</p>
</div>

<h2></h2>
Expand Down
2 changes: 1 addition & 1 deletion docs/setup.html
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@
<div style="border: 2px solid red; padding: 10px; margin-bottom: 20px;">
<h3 style="color: red;">Notice</h3>
<p>This is a raw view of the Python source code due to an error in generating the documentation.</p>
<p><strong>Date of Conversion:</strong> 2025-02-27 14:45:05</p>
<p><strong>Date of Conversion:</strong> 2025-02-27 15:45:20</p>
</div>

<h2></h2>
Expand Down

0 comments on commit c4fdfd8

Please sign in to comment.