You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-44Lines changed: 20 additions & 44 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,40 +10,28 @@
10
10
11
11
## Contents
12
12
13
-
-[Ways to Use FEAScript](#ways-to-use-feascript)
14
-
-[FEAScript API](#feascript-api)
15
-
-[Use FEAScript in the Browser](#use-feascript-in-the-browser)
16
-
-[Use FEAScript with Node.js](#use-feascript-with-nodejs)
17
-
-[Use FEAScript in JavaScript Playgrounds](#use-feascript-in-javascript-playgrounds)
18
-
-[FEAScript Studio](#feascript-studio)
13
+
-[How to Use FEAScript](#ways-to-use-feascript)
14
+
-[Use FEAScript in the Browser](#use-feascript-in-the-browser)
15
+
-[Use FEAScript with Node.js](#use-feascript-with-nodejs)
16
+
-[Use FEAScript in JavaScript Playgrounds](#use-feascript-in-javascript-playgrounds)
19
17
-[Quick Example](#quick-example)
20
18
-[Support FEAScript](#support-feascript)
21
19
-[Contributing](#contributing)
22
20
-[License](#license)
23
21
24
-
## Ways to Use FEAScript
22
+
## How to Use FEAScript
25
23
26
-
FEAScript offers two main approaches to creating simulations:
27
-
28
-
1.**[FEAScript API](#feascript-api)** – For developers comfortable with coding, providing full programmatic control in browsers, Node.js, or interactive notebooks.
29
-
2.**[FEAScript Studio](#feascript-studio)** – A visual (based on [Blockly](https://blockly.com/)) and code-based environment for building simulations in the browser.
30
-
31
-
Each approach is explained in detail below.
32
-
33
-
### FEAScript API
34
-
35
-
The FEAScript API is the core programmatic interface for FEAScript. Written entirely in pure JavaScript, it runs in three environments:
24
+
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:
36
25
37
26
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.
38
-
2.**[With Node.js](#use-feascript-with-nodejs)** – Use FEAScript in server-side JavaScript applications.
39
-
3.**[In JavaScript playgrounds](#use-feascript-in-javascript-playgrounds)** – Try FEAScript in interactive JavaScript playgrounds such as [CopePen](https://codepen.io/FEAScript) or [Scribbler](https://hub.scribbler.live/portfolio/#!nikoscham/FEAScript-Scribbler-examples).
27
+
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).
28
+
3.**[With Node.js](#use-feascript-with-nodejs)** – Use FEAScript in server-side JavaScript applications.
40
29
41
30
#### Use FEAScript in the Browser
42
31
43
32
You can use FEAScript in browser environments in three ways:
For users who prefer a visual approach to creating simulations, [FEAScript Studio](https://feascript.com/feascript-studio.html) offers a browser-based visual editor that allows you to:
110
-
111
-
- Build and run finite element simulations directly in your browser by connecting visual blocks together (based on the [Blockly](https://blockly.com/) library).
112
-
- Combine a no-code workflow with an integrated code editor when you need more control.
113
-
- Save and share projects.
114
-
115
-
While the FEAScript API provides full programmatic control for advanced customization, FEAScript Studio offers a visual interface for creating and editing simulations.
116
-
117
-
Join the [waitlist](https://feascript.com/feascript-studio.html#waitlist) to get updates about FEAScript Studio and be among the first to try it when it’s released.
118
-
119
95
## Quick Example
120
96
121
97
Here is a minimal browser-based example using the FEAScript API. Adapt paths, physics model, and boundary conditions as needed for your specific problem:
@@ -157,7 +133,7 @@ Here is a minimal browser-based example using the FEAScript API. Adapt paths, ph
157
133
158
134
**Note:** The code above uses placeholder values that you should replace with appropriate options, e.g.:
159
135
160
-
- "solverType" should be replaced with an actual solver type such as "heatConductionScript" for heat conduction problems
136
+
- "physicsModel" should be replaced with an actual solver type such as "heatConductionScript" for heat conduction problems
161
137
- "conditionType" should be replaced with an actual boundary condition type such as "constantTemp"
162
138
- "boundaryIndex" should be replaced with a string identifying the boundary
163
139
@@ -166,10 +142,10 @@ Here is a minimal browser-based example using the FEAScript API. Adapt paths, ph
166
142
> 💖 **If you find FEAScript useful, please consider supporting its development through a donation:**
0 commit comments