Skip to content

Commit bd40d31

Browse files
committed
Add latest release information and quick start guide to index.html
1 parent 1fd9a16 commit bd40d31

File tree

1 file changed

+78
-20
lines changed

1 file changed

+78
-20
lines changed

index.html

Lines changed: 78 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@
2727
<!-- Link to the CSS files -->
2828
<link href="FEAScript-website.css" rel="stylesheet" type="text/css" />
2929
<link href="https://fonts.googleapis.com/css2?family=Roboto:wght@400;700&display=swap" rel="stylesheet" />
30+
<!-- Import the run_prettify.js library for JavaScript code coloring *** Deprecated library *** -->
31+
<script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js"></script>
3032
</head>
3133

3234
<!-- Google tag (gtag.js) -->
@@ -117,6 +119,7 @@ <h2 id="gettingstarted"><a name="Getting Started"></a>Getting Started</h2>
117119
browser, without the need for any cloud services. The entire workflow is performed using JavaScript
118120
objects directly in the HTML file.
119121
</p>
122+
120123
<p>There are two ways to create simulations with FEAScript:</p>
121124
<ul>
122125
<li>
@@ -131,6 +134,58 @@ <h2 id="gettingstarted"><a name="Getting Started"></a>Getting Started</h2>
131134
</li>
132135
</ul>
133136

137+
<!-- New section: Latest Release and Roadmap -->
138+
<div class="highlight-container" style="margin-bottom: 1.5em">
139+
<p>
140+
<strong>Latest stable release:</strong>
141+
<a href="https://github.com/FEAScript/FEAScript-core/releases/tag/0.1.0" target="_blank">0.1.0</a>
142+
<br />
143+
<strong>See the roadmap for the upcoming release </strong>
144+
<a href="https://github.com/orgs/FEAScript/discussions/17" target="_blank">0.2.0</a>
145+
</p>
146+
</div>
147+
148+
<p>
149+
<strong>Quick Start:</strong> Include FEAScript in your HTML via CDN or download from
150+
<a href="https://github.com/FEAScript/FEAScript-core" target="_blank">GitHub</a> &#8594; add a canvas
151+
(e.g., <code>&lt;div id="solutionPlot">&lt;/div&gt;</code>) &#8594; add a mesh file (e.g.,
152+
<code>your.msh</code>) or use FEAScript mesh generation tools &#8594; create and run a simulation using
153+
the JavaScript API (see <a href="#tutorials">tutorials</a> for detailed examples):
154+
</p>
155+
<pre class="prettyprint">
156+
&lt;body&gt;
157+
. . .
158+
&lt;script type="module"&gt;
159+
import { FEAScriptModel, importGmshQuadTri, plotSolution } from "https://core.feascript.com/src/index.js";
160+
161+
window.addEventListener("DOMContentLoaded", async () => {
162+
// Load and parse Gmsh mesh
163+
const meshContent = await (await fetch("path/to/your.msh")).text();
164+
const meshFile = new File([meshContent], "your.msh");
165+
const parsedMesh = await importGmshQuadTri(meshFile);
166+
167+
// Create and configure model
168+
const model = new FEAScriptModel();
169+
model.setSolverConfig("solverType"); // e.g., "solidHeatTransferScript"
170+
model.setMeshConfig({
171+
parsedMesh,
172+
meshDimension: "2D",
173+
elementOrder: "linear" // "linear" or "quadratic"
174+
});
175+
176+
// Apply boundary conditions (Gmsh physical group tags)
177+
model.addBoundaryCondition("boundaryIndex", ["conditionType", /* parameters */]);
178+
179+
// Solve
180+
const { solutionVector, nodesCoordinates } = model.solve();
181+
182+
// Plot results
183+
plotSolution(solutionVector, nodesCoordinates, model.solverConfig, "2D", "contour", "solutionPlot", "unstructured");
184+
});
185+
&lt;/script&gt;
186+
. . .
187+
&lt;/body&gt;</pre
188+
>
134189
<p>
135190
🚧
136191
<strong>FEAScript is currently under heavy development with new features being added regularly</strong>.
@@ -142,6 +197,7 @@ <h2 id="gettingstarted"><a name="Getting Started"></a>Getting Started</h2>
142197
</p>
143198

144199
<h2 id="features"><a name="Features"></a>Features</h2>
200+
145201
<p>The following lists contain some, but not all, of the available features in FEAScript:</p>
146202
<ul>
147203
<li>
@@ -150,26 +206,6 @@ <h2 id="features"><a name="Features"></a>Features</h2>
150206
<li>Solid heat conduction solver</li>
151207
</ul>
152208
</li>
153-
<li>
154-
<b>Numerical Solution</b>
155-
<ul>
156-
<li>
157-
General form differential equations solver
158-
<i
159-
><a href="https://github.com/FEAScript/FEAScript-core/issues/3" target="_blank"
160-
>(under development)</a
161-
></i
162-
>
163-
</li>
164-
<li>Linear system solvers (LU decomposition, Jacobi method)</li>
165-
</ul>
166-
</li>
167-
<li>
168-
<b>Parallelization</b>
169-
<ul>
170-
<li>Web worker support for multi-threaded computation</li>
171-
</ul>
172-
</li>
173209
<li>
174210
<b>Geometry and Meshing</b>
175211
<ul>
@@ -194,6 +230,28 @@ <h2 id="features"><a name="Features"></a>Features</h2>
194230
</li>
195231
</ul>
196232
</li>
233+
<li>
234+
<b>Numerical Solution</b>
235+
<ul>
236+
<!--
237+
<li>
238+
General form differential equations solver
239+
<i
240+
><a href="https://github.com/FEAScript/FEAScript-core/issues/3" target="_blank"
241+
>(under development)</a
242+
></i
243+
>
244+
</li>
245+
-->
246+
<li>Linear system solvers (LU decomposition, Jacobi method)</li>
247+
</ul>
248+
</li>
249+
<li>
250+
<b>Parallelization</b>
251+
<ul>
252+
<li>Web worker support for multi-threaded computation</li>
253+
</ul>
254+
</li>
197255
<li>
198256
<b>Visualization</b>
199257
<ul>

0 commit comments

Comments
 (0)