Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 20 additions & 8 deletions NOTICE.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,29 @@
FEAScript makes use of the following third-party software:

1. **math.js**
1. **Comlink**
- License: Apache 2.0 (https://github.com/GoogleChromeLabs/comlink/blob/main/LICENSE)
- Source: https://github.com/GoogleChromeLabs/comlink

2. **d3-scale**
- License: ISC (https://github.com/d3/d3-scale/blob/main/LICENSE)
- Source: https://github.com/d3/d3-scale

3. **gl-matrix**
- License: MIT (https://github.com/toji/gl-matrix/blob/master/LICENSE.md)
- Source: https://github.com/toji/gl-matrix

4. **math.js**
- License: Apache 2.0 (https://github.com/josdejong/mathjs/blob/develop/LICENSE)
- Source: https://github.com/josdejong/mathjs

2. **plotly.js**
5. **plotly.js**
- License: MIT (https://github.com/plotly/plotly.js/blob/master/LICENSE)
- Source: https://github.com/plotly/plotly.js/tree/master

3. **Comlink**
- License: Apache 2.0 (https://github.com/GoogleChromeLabs/comlink/blob/main/LICENSE)
- Source: https://github.com/GoogleChromeLabs/comlink

4. **taichi.js**
6. **taichi.js**
- License: MIT (https://github.com/AmesingFlank/taichi.js/blob/main/LICENSE)
- Source: https://github.com/AmesingFlank/taichi.js
- Source: https://github.com/AmesingFlank/taichi.js

7. **vtk.js**
- License: BSD 3-Clause (https://github.com/Kitware/vtk-js/blob/master/LICENSE)
- Source: https://github.com/Kitware/vtk-js
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
- <b>Meshing:</b> simple 1D/2D mesh generation, unstructured mesh import from Gmsh (`.msh`)
- <b>Solvers:</b> frontal, Jacobi (CPU/WebGPU) and LU, Newton–Raphson for nonlinear systems
- <b>Performance:</b> web worker support for multi-threaded computation
- <b>Visualization:</b> interactive plots with Plotly
- <b>Visualization:</b> interactive rendering with vtk.js and Plotly

<!-- ## Contents

Expand Down Expand Up @@ -84,7 +84,7 @@ FEAScript works well in interactive JavaScript playgrounds where you can write c
Install FEAScript and its peer dependencies from npm as follows:

```bash
npm install feascript mathjs plotly.js
npm install feascript mathjs
```

Then, import it in your JavaScript file:
Expand Down
5 changes: 3 additions & 2 deletions dist/feascript.cjs.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dist/feascript.cjs.js.map

Large diffs are not rendered by default.

5 changes: 3 additions & 2 deletions dist/feascript.esm.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dist/feascript.esm.js.map

Large diffs are not rendered by default.

5 changes: 3 additions & 2 deletions dist/feascript.umd.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dist/feascript.umd.js.map

Large diffs are not rendered by default.

4 changes: 0 additions & 4 deletions examples/creepingFlowScript/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,6 @@ This directory contains Node.js examples demonstrating how to use the FEAScript

This example solves a 2D lid-driven cavity flow using the creeping flow solver with Taylor-Hood (Q2-Q1) elements. For detailed information on the model setup, refer to the corresponding [tutorial](https://un5peqtmyvbr2nu3.julianrbryant.com/tutorials/lid-driven-cavity-2d-creeping-flow.html) on the FEAScript website.

## HTML Examples

Each example also includes an HTML variant (e.g., `lidDrivenCavity2DCreepingFlow.html`) that runs the same simulation in the browser with built-in visualization using Plotly.js. Simply open the HTML file in a web browser to run.

## Running the Node.js Examples

#### 1. Create package.json with ES module support:
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* ════════════════════════════════════════════════════════════════
* FEAScript Core Library
* Lightweight Finite Element Simulation in JavaScript
* Version: 0.2.0 | https://un5peqtmyvbr2nu3.julianrbryant.com
* Version: 0.3.0 (RC) | https://un5peqtmyvbr2nu3.julianrbryant.com
* MIT License © 2023–2026 FEAScript
* ════════════════════════════════════════════════════════════════
*/
Expand Down
4 changes: 0 additions & 4 deletions examples/frontPropagationScript/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,6 @@ This directory contains Node.js examples demonstrating how to use the FEAScript

This example demonstrates solving an eikonal equation in a 2D domain to track the movement of a solidification interface. For detailed information on the model setup, refer to the corresponding [tutorial](https://un5peqtmyvbr2nu3.julianrbryant.com/tutorials/solidification-front-2d.html) in the FEAScript website.

## HTML Examples

Each example also includes an HTML variant (e.g., `solidificationFront2D.html`) that runs the same simulation in the browser with built-in visualization using Plotly.js. Simply open the HTML file in a web browser to run.

## Running the Node.js Examples

#### 1. Create package.json with ES module support:
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* ════════════════════════════════════════════════════════════════
* FEAScript Core Library
* Lightweight Finite Element Simulation in JavaScript
* Version: 0.2.0 | https://un5peqtmyvbr2nu3.julianrbryant.com
* Version: 0.3.0 (RC) | https://un5peqtmyvbr2nu3.julianrbryant.com
* MIT License © 2023–2026 FEAScript
* ════════════════════════════════════════════════════════════════
*/
Expand Down
4 changes: 0 additions & 4 deletions examples/generalFormPDEScript/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,6 @@ This directory contains Node.js examples demonstrating how to use the FEAScript

This example demonstrates solving a one-dimensional advection-diffusion problem with a Gaussian source term. The problem models the transport of a substance under the effects of both diffusion and advection. For detailed information on the model setup, refer to the corresponding [tutorial](https://un5peqtmyvbr2nu3.julianrbryant.com/tutorials/advection-diffusion-1d.html) in the FEAScript website.

## HTML Examples

Each example also includes an HTML variant (e.g., `advectionDiffusion1D.html`) that runs the same simulation in the browser with built-in visualization using Plotly.js. Simply open the HTML file in a web browser to run.

## Running the Node.js Examples

#### 1. Create package.json with ES module support:
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* ════════════════════════════════════════════════════════════════
* FEAScript Core Library
* Lightweight Finite Element Simulation in JavaScript
* Version: 0.2.0 | https://un5peqtmyvbr2nu3.julianrbryant.com
* Version: 0.3.0 (RC) | https://un5peqtmyvbr2nu3.julianrbryant.com
* MIT License © 2023–2026 FEAScript
* ════════════════════════════════════════════════════════════════
*/
Expand Down
4 changes: 0 additions & 4 deletions examples/heatConductionScript/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,6 @@ Implementation using a Gmsh-generated mesh for a rhomboid domain (the mesh file,

For detailed information on the model setup, refer to the corresponding [tutorial](https://un5peqtmyvbr2nu3.julianrbryant.com/tutorials/heat-conduction-2d-rhom-fin-gmsh.html) in the FEAScript website.

## HTML Examples

Each example also includes an HTML variant (e.g., `heatConduction1DWall.html`, `heatConduction2DFin.html`) that runs the same simulation in the browser with built-in visualization using Plotly.js. Simply open the HTML file in a web browser to run.

## Running the Node.js Examples

#### 1. Create package.json with ES module support:
Expand Down
Loading
Loading