Skip to content

Commit 70e8d5f

Browse files
nikoschamnikoscham
committed
Enhance layout by setting max-width for unordered lists; update page title and improve clarity in Getting Started section
1 parent 33135c5 commit 70e8d5f

2 files changed

Lines changed: 106 additions & 53 deletions

File tree

‎FEAScript-website.css‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ body {
3030

3131
ul {
3232
padding-left: 1.5em;
33+
max-width: 1000px;
3334
}
3435

3536
/* Default max-width for content elements */

‎index.html‎

Lines changed: 105 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
<html>
1414
<head>
15-
<title>FEAScript: A JavaScript Finite Element Simulation Library</title>
15+
<title>FEAScript Finite Element Simulation Library</title>
1616
<link rel="icon" type="image/x-icon" href="./assets/favicon.ico" />
1717
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
1818
<meta
@@ -146,29 +146,40 @@ <h1>A JavaScript Finite Element Simulation Library</h1>
146146
</div>
147147

148148
<h2 id="gettingstarted"><a name="Getting Started"></a>Getting Started</h2>
149-
<p>
150-
FEAScript is entirely implemented in pure JavaScript and can run in two environments: in the browser
151-
with a simple HTML page or via Node.js for server-side simulations. When running in the browser, all
152-
simulations are executed locally without the need for any cloud services.
153-
</p>
154149

155150
<p>There are two ways to create simulations with FEAScript:</p>
156151
<ul>
157152
<li>
158153
<strong>JavaScript API:</strong> For developers comfortable with coding, the JavaScript API provides
159-
full programmatic control, allowing direct integration into websites or web applications.
154+
full programmatic control. It runs in three environments: in the browser with a simple HTML page, via
155+
Node.js for server-side applications, or with online interactive notebooks.
160156
</li>
161157
<li>
162-
<strong>Visual Editor:</strong> The
158+
<strong>Visual Editor (FEAScript platform):</strong> The
163159
<a href="https://platform.feascript.com">FEAScript platform</a>
164-
provides a no-code, block-based interface for creating simulations without writing any JavaScript
165-
code.
160+
provides a no-code, block-based interface (based on
161+
<a href="https://developers.google.com/blockly/">
162+
Blockly
163+
<img
164+
src="https://upload.wikimedia.org/wikipedia/commons/4/44/Icon_External_Link.svg"
165+
alt="External Link Icon"
166+
style="
167+
width: 16px;
168+
height: 16px;
169+
vertical-align: middle;
170+
margin-left: 2px;
171+
margin-bottom: 4px;
172+
" /></a
173+
>) for creating simulations without writing any JavaScript code. With the FEAScript platform, you can
174+
connect visual blocks, create complex models, and save or load your projects in XML format for easy
175+
sharing and reuse.
166176
</li>
167177
</ul>
178+
168179
<br />
169180
<div class="highlight-container" style="margin-bottom: 1.5em">
170181
<p>
171-
<strong>Latest stable release:</strong>
182+
<strong>FEAScript latest stable release:</strong>
172183
<a href="https://github.com/FEAScript/FEAScript-core/releases">0.1.2</a>
173184
(<a href="https://www.npmjs.com/package/feascript"
174185
>npm
@@ -189,7 +200,7 @@ <h2 id="gettingstarted"><a name="Getting Started"></a>Getting Started</h2>
189200
>
190201
<br />
191202
<strong
192-
>If you find FEAScript useful, please consider supporting its development through a
203+
>💖 If you find FEAScript useful, please consider supporting its development through a
193204
donation:</strong
194205
>
195206
<script src="https://liberapay.com/FEAScript/widgets/button.js"></script>
@@ -249,7 +260,7 @@ <h2 id="gettingstarted"><a name="Getting Started"></a>Getting Started</h2>
249260
>
250261
<p>
251262
<em>
252-
The above code is an indicative usage example of FEAScript. Adapt paths, solver types, and boundary
263+
The above code is an illustrative example. Adapt paths, solver types, and boundary
253264
conditions to your specific problem.
254265
</em>
255266
</p>
@@ -265,10 +276,10 @@ <h2 id="gettingstarted"><a name="Getting Started"></a>Getting Started</h2>
265276

266277
<h2 id="features"><a name="Features"></a>Features</h2>
267278

268-
<p>The following lists contain some, but not all, of the available features in FEAScript:</p>
279+
<p>The following lists highlights key FEAScript features:</p>
269280
<ul>
270281
<li>
271-
🧠 <strong>Physical Modelling</strong>
282+
🧠 <strong>Physical Modeling</strong>
272283
<ul>
273284
<li>Solid heat conduction solver</li>
274285
<li>Front propagation solver</li>
@@ -299,7 +310,7 @@ <h2 id="features"><a name="Features"></a>Features</h2>
299310
</ul>
300311
</li>
301312
<li>
302-
⚙️ <strong>Numerical Solution</strong>
313+
⚙️ <strong>Numerical Methods</strong>
303314
<ul>
304315
<!--
305316
<li>
@@ -312,41 +323,80 @@ <h2 id="features"><a name="Features"></a>Features</h2>
312323
</li>
313324
-->
314325
<li>Linear system solvers (LU decomposition, Jacobi method)</li>
315-
<li>Newton-Raphson method for nonlinear problems</li>
326+
<li>Newton-Raphson method for nonlinear systems</li>
316327
</ul>
317328
</li>
318329
<li>
319-
📊 <strong>Parallelization</strong>
330+
📊 <strong>Performance & Parallelization</strong>
320331
<ul>
321332
<li>Web worker support for multi-threaded computation</li>
322333
</ul>
323334
</li>
324335
<li>
325-
📈 <strong>Visualization</strong>
336+
📈 <strong>Visualization & Post-Processing</strong>
326337
<ul>
327-
<li>Line and surface plotting</li>
338+
<li>
339+
Interactive line and surface visualization with
340+
<a href="https://plotly.com/javascript/">
341+
Plotly
342+
<img
343+
src="https://upload.wikimedia.org/wikipedia/commons/4/44/Icon_External_Link.svg"
344+
alt="External Link Icon"
345+
style="
346+
width: 16px;
347+
height: 16px;
348+
vertical-align: middle;
349+
margin-left: 2px;
350+
margin-bottom: 4px;
351+
"
352+
/>
353+
</a>
354+
</li>
355+
</ul>
356+
</li>
357+
<li>
358+
🚀 <strong>Platform & Deployment</strong>
359+
<ul>
360+
<li>Browser runtime (ES modules)</li>
361+
<li>
362+
Node.js runtime (<a href="https://www.npmjs.com/package/feascript"
363+
>npm
364+
<img
365+
src="https://upload.wikimedia.org/wikipedia/commons/4/44/Icon_External_Link.svg"
366+
alt="External Link Icon"
367+
style="
368+
width: 16px;
369+
height: 16px;
370+
vertical-align: middle;
371+
margin-left: 2px;
372+
margin-bottom: 4px;
373+
" /></a
374+
>)
375+
</li>
376+
<li>
377+
No-code interface with <a href="https://platform.feascript.com">FEAScript platform</a> visual
378+
editor
379+
</li>
380+
<li>
381+
Online notebooks integration (<a
382+
href="https://hub.scribbler.live/portfolio/#!nikoscham/FEAScript-Scribbler-examples"
383+
>Scribbler
384+
<img
385+
src="https://upload.wikimedia.org/wikipedia/commons/4/44/Icon_External_Link.svg"
386+
alt="External Link Icon"
387+
style="
388+
width: 16px;
389+
height: 16px;
390+
vertical-align: middle;
391+
margin-left: 2px;
392+
margin-bottom: 4px;
393+
" /></a
394+
>)
395+
</li>
328396
</ul>
329397
</li>
330398
</ul>
331399

332-
<p>
333-
For a visual approach to creating simulations, we are also developing the
334-
<a href="https://platform.feascript.com">FEAScript platform</a> - a
335-
<strong>browser-based visual editor</strong> built on the
336-
<a href="https://developers.google.com/blockly/"
337-
>Blockly
338-
<img
339-
src="https://upload.wikimedia.org/wikipedia/commons/4/44/Icon_External_Link.svg"
340-
alt="External Link Icon"
341-
style="width: 16px; height: 16px; vertical-align: middle; margin-left: 2px; margin-bottom: 4px"
342-
/></a>
343-
library. This <strong>no-code interface</strong> allows users to build and run finite element
344-
simulations directly in their browser by connecting visual blocks. While FEAScript's JavaScript API
345-
offers full programmatic control for advanced customization, the FEAScript platform provides an
346-
accessible entry point for users without coding experience. FEAScript platform also provides the ability
347-
to save and load projects in XML format, enabling easy sharing and reuse of simulation configurations.
348-
</p>
349-
350400
<h2 id="tutorials"><a name="Tutorials"></a>Tutorials</h2>
351401
<p>
352402
Below, you can explore tutorials that provide a step-by-step introduction to FEAScript. These tutorials
@@ -356,36 +406,38 @@ <h2 id="tutorials"><a name="Tutorials"></a>Tutorials</h2>
356406
</p>
357407
<ul>
358408
<li>
359-
<strong>Heat conduction through wall</strong>:
360-
<a href="https://feascript.com/tutorials/HeatConduction1DWall.html">API</a>
409+
<strong>Heat conduction through a wall</strong>:
410+
<a href="https://feascript.com/tutorials/HeatConduction1DWall.html">API (browser-based)</a>
361411
|
362-
<a href="https://feascript.com/tutorials/HeatConduction1DWallPlatform.html"
363-
>XML (FEAScript platform)</a
364-
>
412+
<a href="https://feascript.com/tutorials/HeatConduction1DWallPlatform.html">FEAScript platform</a>
365413
</li>
366414
<li>
367415
<strong>Heat conduction in a two-dimensional fin</strong>:
368-
<a href="https://feascript.com/tutorials/HeatConduction2DFin.html">API (standard)</a>
416+
<a href="https://feascript.com/tutorials/HeatConduction2DFin.html">API (browser-based)</a>
369417
|
370-
<a href="https://feascript.com/tutorials/HeatConduction2DFinWorker.html">API (web worker)</a>
371-
|
372-
<a href="https://feascript.com/tutorials/HeatConduction2DFinGmsh.html">API (Gmsh mesh)</a>
418+
<a href="https://feascript.com/tutorials/HeatConduction2DFinWorker.html"
419+
>API (browser-based with web worker)</a
420+
>
373421
|
374-
<a href="https://feascript.com/tutorials/HeatConduction2DFinPlatform.html"
375-
>XML (FEAScript platform)</a
422+
<a href="https://feascript.com/tutorials/HeatConduction2DFinGmsh.html"
423+
>API (browser-based with Gmsh mesh)</a
376424
>
425+
|
426+
<a href="https://feascript.com/tutorials/HeatConduction2DFinPlatform.html">FEAScript platform</a>
377427
</li>
378428
<li>
379429
<strong>Solidification front propagation in a two-dimensional domain</strong>:
380-
<a href="https://feascript.com/tutorials/SolidificationFront2D.html">API (standard)</a>
430+
<a href="https://feascript.com/tutorials/SolidificationFront2D.html">API (browser-based)</a>
381431
|
382-
<a href="https://feascript.com/tutorials/SolidificationFront2DWorker.html">API (web worker)</a>
432+
<a href="https://feascript.com/tutorials/SolidificationFront2DWorker.html"
433+
>API (browser-based with web worker)</a
434+
>
383435
</li>
384436
</ul>
385437
<p>
386438
Please report any feedback on the above tutorials to the GitHub
387-
<a href="https://github.com/orgs/FEAScript/discussions">discussions</a> or
388-
<a href="https://github.com/FEAScript/FEAScript-core/issues">issues</a>.
439+
<a href="https://github.com/orgs/FEAScript/discussions">Discussions</a> or
440+
<a href="https://github.com/FEAScript/FEAScript-core/issues">Issues</a>.
389441
</p>
390442

391443
<h2 id="documentation"><a name="Documentation"></a>Documentation</h2>

0 commit comments

Comments
 (0)