FEAScript-core

KO | EN

gitlite — search

#hacktoberfest #ai #typescript #go #golang #android #docker #java #windows #awesome #vue #pytorch #security #openai

(★ 69)

JavaScript Finite Element Simulation Library

FEAScript-core Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# FEAScript-core

[![GitHub release](https://img.shields.io/github/v/release/FEAScript/FEAScript-core?logo=github)](https://github.com/FEAScript/FEAScript-core/releases)
[![npm version](https://img.shields.io/npm/v/feascript)](https://www.npmjs.com/package/feascript)
[![Last Commit](https://img.shields.io/github/last-commit/FEAScript/FEAScript-core?logo=github)](https://github.com/FEAScript/FEAScript-core/commits/main)
[![License](https://img.shields.io/github/license/FEAScript/FEAScript-core?logo=github)](https://github.com/FEAScript/FEAScript-core/blob/main/LICENSE)
[![GitHub Sponsors](https://img.shields.io/badge/Sponsor-GitHub%20Sponsors-ea4aaa?logo=githubsponsors&logoColor=white)](https://github.com/sponsors/FEAScript)
[![Donate on Liberapay](https://img.shields.io/badge/Donate-Liberapay-F6C915?logo=liberapay&logoColor=black)](https://liberapay.com/FEAScript/donate)

[FEAScript](https://feascript.com/) is a finite element simulation library developed in JavaScript. It enables engineering simulations across both browser-based and server-side environments without the overhead of traditional desktop software. 🎯 **Our goal is to provide the most powerful JavaScript API for FEM.** We are closing the gap between complex computational mechanics and the accessibility of the web, empowering developers to build professional-grade simulation tools that work on any device, anywhere. This is the core library of the FEAScript project.

> 🚧 **FEAScript is currently under heavy development.** Its functionality and interfaces may change rapidly as new features and enhancements are introduced.

## Features

- <b>Physics models:</b> creeping (Stokes) flow, front propagation, heat conduction
- <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 rendering with vtk.js and Plotly

<!-- ## Contents

- [How to Use FEAScript](#ways-to-use-feascript)
- [Features](#features)
- [Examples](#examples)
- [Support FEAScript](#support-feascript)
- [Contributing](#contributing)
- [License](#license) -->

## How to Use FEAScript

You can run simulations with FEAScript by calling its functions from JavaScript (the FEAScript API). The API is the core programmatic interface for FEAScript and works across multiple environments, including the browser (simple HTML pages and online JavaScript playgrounds, e.g. [CodePen](https://codepen.io/) and [Scribbler](https://scribbler.live/)) and server-side runtimes such as Node.js. The most common ways to use FEAScript are outlined below:

1. **[In the browser](#use-feascript-in-the-browser)** – Run FEAScript directly in a simple HTML page to perform simulations locally with no additional installations or cloud services required.
2. **[In JavaScript playgrounds](#use-feascript-in-javascript-playgrounds)** – Try FEAScript in interactive JavaScript playgrounds such as [CodePen](https://codepen.io/FEAScript) or [Scribbler](https://hub.scribbler.live/portfolio/#!nikoscham/FEAScript-Scribbler-examples).
3. **[With Node.js](#use-feascript-with-nodejs)** – Use FEAScript in server-side JavaScript applications.

#### Use FEAScript in the Browser

You can use FEAScript in browser environments in three ways:

- **Import from Hosted ESM Build:**

```html
  <script type="module">
    import { FEAScriptModel } from "https://core.feascript.com/dist/feascript.esm.js";
  </script>
  ```

- **Import from CDN:**

```html
  <script type="module">
    import { FEAScriptModel } from "https://cdn.jsdelivr.net/gh/FEAScript/FEAScript-core/dist/feascript.esm.js";
  </script>
  ```

- **Download and Use Locally:**

You can download the latest stable release from [GitHub Releases](https://github.com/FEAScript/FEAScript-core/releases).

```html
  <script type="module">
    import { FEAScriptModel } from "./path/to/dist/feascript.esm.js";
  </script>
  ```

👉 Explore browser-based tutorials on our [website](https://feascript.com/#tutorials).

#### Use FEAScript in JavaScript Playgrounds

FEAScript works well in interactive JavaScript playgrounds where you can write code, visualize results inline, and share your work.

👉 Explore the following examples:

- [CodePen (interactive pens)](https://codepen.io/FEAScript)
- [Scribbler (notebooks)](https://hub.scribbler.live/portfolio/#!nikoscham/FEAScript-Scribbler-examples)

#### Use FEAScript with Node.js

Install FEAScript and its peer dependencies from npm as follows:

```bash
npm install feascript
```

Then, import it in your JavaScript file:

```javascript
import { FEAScriptModel } from "feascript";
```

**Important:** FEAScript is built as an ES module. If you're starting a completely new project (outside this repository), make sure to configure it to use ES modules by:

```bash
# Create package.json with type=module for ES modules support
echo '{"type":"module"}' > package.json
```

When running examples from within this repository, this step isn’t needed as the root package.json already has the proper configuration.

👉 Explore Node.js use cases on the [examples directory](https://github.com/FEAScript/FEAScript-core/tree/main/examples).

## Examples

Here is a minimal browser-based example using the FEAScript API. Adapt paths, physics model, and boundary conditions as needed for your specific problem:

```html
<body>
  
  <script type="module">
    // Import FEAScript library
    import { FEAScriptModel } from "https://core.feascript.com/dist/feascript.esm.js";

window.addEventListener("DOMContentLoaded", () => {
      // Create a new FEAScript model
      const model = new FEAScriptModel();

// Select physics/PDE
      model.setModelConfig("physicsModel"); // Example: "heatConductionScript"

// Configure the mesh
      model.setMeshConfig({
        meshDimension: "1D", // Choose either "1D" or "2D"
        elementOrder: "linear", // Choose either "linear" or "quadratic"
        numElementsX: 10, // Number of elements in x-direction
        numElementsY: 6, // Number of elements in y-direction (for 2D only)
        maxX: 1.0, // Domain length in x-direction
        maxY: 0.5, // Domain length in y-direction (for 2D only)
      });

// Add boundary conditions with appropriate parameters
      model.addBoundaryCondition("boundaryIndex", ["conditionType" /* parameters */]); // Example boundary condition

// Solve the problem
      const { solutionVector, nodesCoordinates } = model.solve();
    });
  </script>
  
</body>
```

**Note:** The code above uses placeholder values that you should replace with appropriate options, e.g.:

- "physicsModel" should be replaced with an actual solver type such as "heatConductionScript" for heat conduction problems
- "conditionType" should be replaced with an actual boundary condition type such as "constantTemp"
- "boundaryIndex" should be replaced with a string identifying the boundary

Furthermore, the scripts under `examples/` contain Node.js examples. You can run them from the `FEAScript-core/` directory as follows:

```bash
node examples/heatConductionScript/heatConduction1DWall/heatConduction1DWall.js
```

Each script prints its computed solution to the console.

## Support FEAScript

> 💖 **If you find FEAScript useful, please consider supporting its development through a donation:**

[![GitHub Sponsors](https://img.shields.io/badge/Sponsor-GitHub%20Sponsors-ea4aaa?logo=githubsponsors&logoColor=white)](https://github.com/sponsors/FEAScript)
[![Donate on Liberapay](https://img.shields.io/badge/Donate-Liberapay-F6C915?logo=liberapay&logoColor=black)](https://liberapay.com/FEAScript/donate)

Your support helps ensure the continued development and maintenance of this project.

## Contributing

We warmly welcome contributors to help expand and refine FEAScript. Please see the [CONTRIBUTING.md](./CONTRIBUTING.md) file for detailed guidance on how to contribute.

## License

The core library of FEAScript is released under the [MIT license](https://github.com/FEAScript/FEAScript-core/blob/main/LICENSE). &copy; 2023-2026 FEAScript.

FEAScript-core

FEAScript-core Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

FEAScript-core

FEAScript-core Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README