suanPan

<img src="Resource/suanPan-qr-ua.svg" width="150" align="middle"/><img src="Resource/suanPan-ua.svg" width="150" align="middle"/>

[!IMPORTANT]

• Feature requests can be made via creating new issues.
• Check out the VS Code extension for syntax highlighting and autocompletion.
• Check out the documentation for a summary of all available functionalities.
• Please star ⭐ the project!

Introduction

🧮 suanPan is a finite element method (FEM) simulation platform for applications in fields such as solid mechanics and civil/structural/seismic engineering. suanPan is written in modern high-quality C++ code and is targeted to provide an efficient, concise, flexible and reliable FEM simulation platform.

suanPan is partially influenced by popular (non-)commercial FEA packages, such as ABAQUS UNIFIED FEA, ANSYS and OpenSees.

<p align="center"><img src="https://repobeats.axiom.co/api/embed/dc2e0bf6251aec5423157991015e9f2582618226.svg" alt="Activities"></p>

Features

The highlights of suanPan are

• ✅ fast, memory and thread safe
• ✅ shared memory parallelism support
• ✅ distributed memory parallelism support
• ✅ multi-architecture (amd64 and arm64) support
• ✅ rich collection of elements, materials, time integration methods, etc.
• ✅ open source and easy to extend
• ✅ modern language features

Quick Start

Execute the application out-of-the-box in terminal on Linux using one of the following commands depending on how the application is obtained. See details below.

# in folder bin/ for linux portable tarball
./suanPan.sh
# for linux packages and snap
suanPan
# for flatpak
flatpak run io.github.tlcfem.suanPan

Or on Windows,

# in the folder containing suanPan.exe
.\suanPan.exe

First time users can use overview command to go through a quick introduction.

+--------------------------------------------------------+
|             ____             suanPan is an open source |
|   ___ _   _|  _ \ __ _ _ __     FEM framework (64-bit) |
|  / __| | | | |_) / _` | '_ \           Canopus (3.7.0) |
|  \__ \ |_| |  __/ (_| | | | |        by tlc @ c34df242 |
|  |___/\__,_|_|   \__,_|_| |_|      all rights reserved |
|                                 10.5281/zenodo.1285221 |
+--------------------------------------------------------+
|  https://github.com/TLCFEM/suanPan                     |
|  https://tlcfem.github.io/suanPan-manual/latest        |
+--------------------------------------------------------+
|  https://bit.ly/vsc-sp                                 |
+--------------------------------------------------------+

suanPan ~<> overview

Sample models are available for almost all models/commands. Please check the Example folder for details. Further details can be seen here regarding how to run model files.

Installation

[!TIP] Daily debug builds can be downloaded via this page.

[!WARNING] Only the 64-bit version is compiled. It is assumed that AVX2 is available thus if the program fails, please check if your CPU supports AVX2. Alternatively, you can try the no-avx version.

Windows

[!NOTE] The dependencies are bundled with the archive. One may also install the VC++ redistributable package. If the application prompts that some file, such as msvcp140.dll, is missing (unlikely), please install the redistributable package.

Binary Package

The archives of binaries are released under Release page. All are portable archives, simply unpack and execute the application.

Chocolatey

The binaries, which are compiled with Intel MKL and VTK, are available on Chocolatey, please use the following command to install the package.

1. Follow the instructions to install Chocolatey.

2. Use the following command to install suanPan.

   choco install suanpan
   

3. It is recommended to use a modern terminal such as Windows Terminal for better output display.

The Chocolatey repo available to you may not be up-to-date. If the latest version is not available, please try alternatives, such as portable binaries or scoop.

<p align="center"><a href="https://asciinema.org/a/684063"><img src="Resource/choco.gif" alt="Installation Demo"></a></p>

Scoop

It is also possible to use Scoop to install the package.

1. Install Scoop.

   Set-ExecutionPolicy RemoteSigned -scope CurrentUser
   iwr -useb get.scoop.sh | iex
   

2. Install suanPan.

   scoop install suanpan
   

Code Signing Policy

Free code signing provided by SignPath.io, certificate by SignPath Foundation.

This program will not transfer any information to other networked systems unless specifically requested by the user or the person installing or operating it.

Linux

Linux users are recommended to obtain the binaries via snap or flatpak.

Snap

The snap supports visualisation via VTK and uses Intel MKL for linear algebra. The edge channel is in sync with the dev branch. The stable channel is in sync with the master branch.

<p align="center"><a href="https://asciinema.org/a/684061"><img src="Resource/snap.gif" alt="Installation Demo"></a></p>

Flatpak

Flatpak is also available if preferred. The beta channel is in sync with the dev branch. The stable channel is in sync with the master branch.

<a href='https://flathub.org/apps/details/io.github.tlcfem.suanPan'><img width='200' alt='Download on Flathub' src='https://flathub.org/api/badge?svg&