Downloads:
1,820
Downloads of v 3.1.0:
49
Last Update:
01 Oct 2023
Package Maintainer(s):
Software Author(s):
- Theodore Chang
Tags:
fem hpc igasuanPan
This is not the latest version of suanPan available.
- 1
- 2
- 3
3.1.0 | Updated: 01 Oct 2023
Downloads:
1,820
Downloads of v 3.1.0:
49
Maintainer(s):
Software Author(s):
- Theodore Chang
suanPan 3.1.0
This is not the latest version of suanPan available.
- 1
- 2
- 3
Some Checks Have Failed or Are Not Yet Complete
Not All Tests Have Passed
Deployment Method: Individual Install, Upgrade, & Uninstall
To install suanPan, run the following command from the command line or from PowerShell:
To upgrade suanPan, run the following command from the command line or from PowerShell:
To uninstall suanPan, run the following command from the command line or from PowerShell:
Deployment Method:
This applies to both open source and commercial editions of Chocolatey.
1. Enter Your Internal Repository Url
(this should look similar to https://community.chocolatey.org/api/v2/)
2. Setup Your Environment
1. Ensure you are set for organizational deployment
Please see the organizational deployment guide
2. Get the package into your environment
Option 1: Cached Package (Unreliable, Requires Internet - Same As Community)-
Open Source or Commercial:
- Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to https://community.chocolatey.org/api/v2/. Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
- You can also just download the package and push it to a repository Download
-
Open Source
-
Download the package:
Download - Follow manual internalization instructions
-
-
Package Internalizer (C4B)
-
Run: (additional options)
choco download suanpan --internalize --version=3.1.0 --source=https://community.chocolatey.org/api/v2/
-
For package and dependencies run:
choco push --source="'INTERNAL REPO URL'"
- Automate package internalization
-
Run: (additional options)
3. Copy Your Script
choco upgrade suanpan -y --source="'INTERNAL REPO URL'" --version="'3.1.0'" [other options]
See options you can pass to upgrade.
See best practices for scripting.
Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.
If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:
choco upgrade suanpan -y --source="'INTERNAL REPO URL'" --version="'3.1.0'"
$exitCode = $LASTEXITCODE
Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
Exit 0
}
Exit $exitCode
- name: Install suanpan
win_chocolatey:
name: suanpan
version: '3.1.0'
source: INTERNAL REPO URL
state: present
See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.
chocolatey_package 'suanpan' do
action :install
source 'INTERNAL REPO URL'
version '3.1.0'
end
See docs at https://docs.chef.io/resource_chocolatey_package.html.
cChocoPackageInstaller suanpan
{
Name = "suanpan"
Version = "3.1.0"
Source = "INTERNAL REPO URL"
}
Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.
package { 'suanpan':
ensure => '3.1.0',
provider => 'chocolatey',
source => 'INTERNAL REPO URL',
}
Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.
4. If applicable - Chocolatey configuration/installation
See infrastructure management matrix for Chocolatey configuration elements and examples.
This package was approved as a trusted package on 01 Oct 2023.
🧮 suanPan is a finite element method (FEM) simulation platform for applications in fields such as solid mechanics and civil/structural/seismic engineering. The name suanPan (in some places such as suffix it is also abbreviated as suPan) comes from the term Suan Pan (算盤), which is Chinese abacus. suanPan is written in modern high quality C++ code and is targeted to provide an efficient, concise, flexible and reliable FEM simulation platform.
@echo off
assoc .sp=suanpanmodel
assoc .supan=suanpanmodel
set "program=%~dp0suanPan.exe"
if not exist "%program%" (
echo suanPan.exe does not exist in current folder
goto byebye
)
ftype suanpanmodel="%program%" "-f" "%%1"
set "program=%program:\=/%"
set "target=%appdata%\Sublime Text 3\Packages\User\"
if exist "%target%\" goto copyfile
set "target=%appdata%\Sublime Text\Packages\User\"
if exist "%target%\" goto copyfile
set target=
set /p target="Input path contains sublime_text.exe (leave empty to quit): "
if "%target%" == "" goto byebye
if not exist "%target%\sublime_text.exe" (
echo sublime_text.exe does not exist in the given folder
goto byebye
)
set "target=%target%\Data\Packages\User\"
set "target=%target:\=/%"
:copyfile
echo {"cmd":["%program%","-nc","-f","$file"],"selector":"source.supan","file_patterns":["*.supan","*.sp"]} > "%~dp0suanPan.sublime-build"
xcopy "%~dp0suanPan.sublime*" "%target%"
:byebye
# Changelog
## known issues
1. The `MKL` includes outdated `FEAST`, the external names in `FEAST` library are modified to avoid linking error.
2. The `SPIKE` solver may occasionally hang, to circumvent, try to avoid mixing compilers from different vendors.
3. The `MUMPS` solver throws segfaults with large matrices.
## version 3.1
1. iterative solvers by the Lis library [#145](https://github.com/TLCFEM/suanPan/pull/145)
2. update `Armadillo` to version `12.6.3` [#149](https://github.com/TLCFEM/suanPan/pull/149)
3. add `TimberPD` 3D material for timber [#151](https://github.com/TLCFEM/suanPan/pull/151)
## version 3.0
1. add experimental `MAGMA` based GPU sparse solver [#123](https://github.com/TLCFEM/suanPan/pull/123)
2. add nonlinear transformation for shell elements [#124](https://github.com/TLCFEM/suanPan/pull/124)
3. update `VTK` to version `9.2.6`
4. add `CustomNodeGroup` [#126](https://github.com/TLCFEM/suanPan/pull/126)
5. add `TranslationConnector` [#127](https://github.com/TLCFEM/suanPan/pull/127)
6. add `CustomAmplitude` [#129](https://github.com/TLCFEM/suanPan/pull/129)
7. update `Armadillo` to version `12.2` [#134](https://github.com/TLCFEM/suanPan/pull/134)
8. add `AsymmElastic1D` [#135](https://github.com/TLCFEM/suanPan/pull/135)
9. update `TBB` to version `2021.9.0`
10. update `MUMPS` to version `5.6.0`
## version 2.9
1. matrix optimsation
2. update `Catch2` to version `3.3.1`
3. update `TBB` to version `2021.8.0`
4. add mixed precision algorithm for `MUMPS` solver [#119](https://github.com/TLCFEM/suanPan/pull/119)
5. add `CustomDegradation`, `CustomGurson` and `CustomGurson1D` models
6. update `Armadillo` to version `12.0` [#121](https://github.com/TLCFEM/suanPan/pull/121)
## version 2.8
1. better on screen display with the `fmt` library [#99](https://github.com/TLCFEM/suanPan/pull/99)
2. add command `overview`
3. update `OpenBLAS` to version `0.3.21`
4. add Euler buckling load check for `T2D2` [#104](https://github.com/TLCFEM/suanPan/pull/104)
5. speed-up analysis with visualisation recorder [#102](https://github.com/TLCFEM/suanPan/pull/102)
6. update `VTK` to version `9.2.5`
7. add `Expression` to support custom function definition [#105](https://github.com/TLCFEM/suanPan/pull/105)
8. add `CustomMises1D`, `CustomCC`, `CustomCDP`, `CustomDP`, `CustomJ2` and `CustomHoffman` models
## version 2.7
1. optimise assembling of symmetric global matrices [#79](https://github.com/TLCFEM/suanPan/pull/79)
2. extend `BatheTwoStep` to allow customisation of spectral radius [#81](https://github.com/TLCFEM/suanPan/pull/81) and
sub-step size [#82](https://github.com/TLCFEM/suanPan/pull/82)
3. update `Catch2` to version `2.13.10`
4. update `Armadillo` to version `11.4`
5. update modern `Arpack` [#94](https://github.com/TLCFEM/suanPan/pull/94)
6. add `Tchamwa` [#88](https://github.com/TLCFEM/suanPan/pull/88),
`BatheExplicit` [#90](https://github.com/TLCFEM/suanPan/pull/90)
and `GeneralisedAlphaExplicit` [#93](https://github.com/TLCFEM/suanPan/pull/93) explicit time integration methods
7. add `OALTS` two-step implicit time integration method [#92](https://github.com/TLCFEM/suanPan/pull/92)
8. add `Sinh1D` and `Tanh1D` nonlinear elastic 1D material
9. add `linear_system` flag to speed up linear system analysis
## version 2.6.1
1. add `-nu` (`--noupdate`) flag to skip check of new version on startup
2. fix issue [#74](https://github.com/TLCFEM/suanPan/issues/74)
## version 2.6
1. update `MKL` to version `2022.2.0`
2. update `TBB` to version `2021.7.0`
3. update `VTK` to version `9.2.2`
4. add docker images and docker build scripts
5. add `TabularSpline` amplitude that uses cubic spline interpolation
6. add `upsampling` command to upsample time series data
7. add `sdof_response` command to compute response of single degree of freedom system
8. add `response_spectrum` command to compute response spectrum for given ground motion
## version 2.5
1. reformulate NM sections, add `NMB21E` element with end moment release
2. add couple stress membranes `CST3`, `CST6`, `CSM4-8`
3. add universal iterative solvers `BiCGSTAB` and `GMRES`, and preconditioners `Jacobi` and `ILU`
4. add support for `icx` and `ifx` compilers, add support for `clang` on linux
5. fix a bug in `GSSSS` with loads are applied as support motions, add `GSSSSOptimal` scheme
6. add `MassPoint2D` and `MassPoint3D` elements
## version 2.4
1. add `RestitutionWall` constraint which conserves momentum and energy
2. add `benchmark` command to benchmark platform
3. constraints and loads are processed in a fully parallelized manner
4. add 3D viscous damper `Damper03` and `Damper04`
5. bugfixes
## version 2.3
1. update `Armadillo` to version 11.0
2. relocate history record file under home folder
3. add `GSSSS` integrator
4. `LeeNewmark` now supports `PARDISO`, `CUDA` and `FGMRES` solvers
5. move to `C++20`, need `GCC 10.3.0`, `Clang 13.0.1`, `MSVC 14.31`
6. add `MOMENTUM` to record system momentum
7. use non-iterative algorithm for force based beams `F21`, `F21H` and `F31`
## version 2.2
1. add `example` command to showcase the creation of a simple model
2. update `VTK` to version 9.1.0
3. add `LogicAND`, `LogicOR` and `LogicXOR` convergers to use multiple criteria
4. update `oneMKL` to `2022.0.3` on Windows
5. move to `VS2022`
## version 2.1
1. update `Armadillo` to version 10.8
2. add recorder tag to recorded files, remove timestamp for hdf5 files, easier to manage different recorders
3. several minor bugfixes
4. improve `LeeNewmark` and `LeeNewmarkFull` performance
5. correct multithreaded `SuperLU` implementation, change default number of threads to 10
6. bugfixes regarding sparse matrix representation
## version 2.0
1. fix a bug in elastic stiffness in CDP model
2. add porous media plane strain elements `PCPE4UC`, `PCPE8UC`, `PCPE4DC`, `PCPE8DC`
3. add N-M interaction enabled beam element `NMB31` and `NMB21`
4. add N-M interaction enabled section `NM2D1`, `NM3D1` (elastic) and `NM2D2`, `NM3D2` (inelastic)
5. change Rayleigh damping related syntax to include tangent stiffness term
6. add different stiffness types to `LeeNewmarkFull`, add support of geometry nonlinearity
7. revise section definition
8. add `B3DC` corotational formulation support to 3D beams
## version 1.9
1. update `Armadillo` to version 10.7
2. update `TBB` version 2021.4.0
3. add `FGMRES` iterative solver
4. switch to `core20` on snap
5. fix the visualisation bug with installation via snap
6. add `LineUDL2D` and `LineUDL3D` loads
## version 1.8
1. add `PlaneSymmetric13` and `PlaneSymmetric23` wrappers
2. add `CoulombFriction` material
3. update `Armadillo` to version 10.6
## version 1.7
1. revise `SimpleSand` model
2. add `DafaliasManzari` sand model
3. add `materialtestbystrainhistory` and `materialtestbystresshistory` utility functions
4. bugfix: potential racing in initialising reference dof, change to serial initialisation
5. bugfix: wrong update of plastic strain in `CDP` model
6. add `CDPM2` model with isotropic damage
## version 1.6
1. add `terminal` command and `output_folder` setting
2. some minor updates
## version 1.5
1. add `scoop` support
2. add `Contact3D` 3D node-triangular facet contact element
3. add `NodeLine` and `NodeFacet` contact constraint
4. add `Sleeve2D`, `Sleeve3D`, `MaxGap2D` and `MaxGap3D` constraint
5. update `OpenBLAS` to version 0.3.15
6. update `Material` class to accommodate couple stress related quantities
## version 1.4
1. add `R2D2` and `R3D2` alias for fixed length constraint
2. add `MinGap2D` and `MinGap3D` inequality constraints
3. add `SupportMotion` loads, including `SupportDisplacement`, `SupportVelocity` and `SupportAcceleration`
4. update `Armadillo` to version 10.4
5. add functionality to check new version
6. add `FEAST` solver
7. improve mixed precision solver performance
8. add `CUDA` solver for dense matrix
## version 1.3
1. update handling of constraints and loads
2. store commands in backup file in CLI mode
3. add `FixedLength2D` and `FixedLength3D` nonlinear constraints
4. improve handling of constraints in dynamic analysis
5. add `NLE1D01` model
6. minor bugfixes
## version 1.2
1. remove dependency on `MAGMA`, now `CUDA` is directly used as the GPU solver
2. add `PARDISO` sparse solver
3. upgrade to `Intel oneAPI Toolkit`
4. add C interface material model
5. remove all reinforced elements, reinforcement can be handled by material models
## version 1.1
1. add phase field enabled elements: `DCP3`, `DCP4`, `DC3D4`, `DC3D8` elements
2. add support to record nodal damping/inertial force `DF` and `IF`
3. add regularized `Yeoh` model for compressible rubbers
4. improve stability of `RambergOsgood` model
5. add `LeeNewmarkFull` damping model, improve performance of `LeeNewmark` damping model
6. add shared memory `SuperLU` solver
7. add `Spike` solver for banded matrices
8. add displacement based beam element with end moment release: `B21EL` and `B21EH` elements
9. correct name of `Kelvin` model
## version 1.0
1. initial release
md5: D4AEB7C8828FF2C4681D6332A5E544F2 | sha1: BD2050B43F3ADE95E49E018F4329E83B10EB1AEB | sha256: 8A90E1E81634EAE33D65D34A1BC9E02A8F424DF2F3EF203069C4F2E632E6FE65 | sha512: F7E26F57014DD9D19323E6CE23D4BEF42B6507855E0BC62C0BE94D3A8021B38C8DD7537149A2A3764B6B75E58544C3E452BCCE91B346FABA96CE6BC98383857E
md5: 94921E22810358F27BEF8A7A7BAB3CCE | sha1: E78A1434DD3875A82E46C64BFAA65EF2161DA817 | sha256: EC9DB4062EB835FA250EDC01267CB97EDF68C70B72B085E0FCF035B064C8852D | sha512: 068B8860DD26BB083C263937073ABCDF8F0DC83D9312B311A9321FC90968714493B3F80358D7CF3EB507DB1407A7F11918BDFE26AE4C85F27000285E5C4B33C7
md5: 1BA6D1CF0508775096F9E121A24E5863 | sha1: DF552810D779476610DA3C8B956CC921ED6C91AE | sha256: 74892D9B4028C05DEBAF0B9B5D9DC6D22F7956FA7D7EEE00C681318C26792823 | sha512: 9887D9F5838AA1555EA87968E014EDFE2F7747F138F1B551D1F609BC1D5D8214A5FDAB0D76FCAC98864C1DA5EB81405CA373B2A30CB12203C011D89EA6D069AF
# suanPan
<img src="Resource/suanPan-qr-ua.svg" width="150" align="middle"/><img src="Resource/suanPan-ua.svg" width="150" align="middle"/>
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1285221.svg)](https://doi.org/10.5281/zenodo.1285221)
[![license](https://img.shields.io/github/license/TLCFEM/suanPan.svg?color=44cc11)](https://www.gnu.org/licenses/gpl-3.0)
[![documentation](https://readthedocs.org/projects/suanpan-manual/badge/?version=latest)](https://suanpan-manual.readthedocs.io/?badge=latest)
[![release](https://img.shields.io/github/release-pre/TLCFEM/suanPan.svg?color=44cc11)](https://github.com/TLCFEM/suanPan/releases)
[![suanpan](https://snapcraft.io//suanpan/badge.svg)](https://snapcraft.io/suanpan)
[![Chocolatey](https://img.shields.io/chocolatey/v/suanpan?color=44cc11)](https://chocolatey.org/packages/suanpan)
[![Chocolatey](https://img.shields.io/chocolatey/dt/suanpan?color=44cc11&label=choco%20install)](https://chocolatey.org/packages/suanpan)
[![download](https://img.shields.io/github/downloads/TLCFEM/suanPan/total.svg?color=44cc11)](https://img.shields.io/github/downloads/TLCFEM/suanPan/total.svg?color=44cc11)
[![stable build](https://github.com/TLCFEM/suanPan/workflows/Stable%20Release/badge.svg?branch=master)](https://github.com/TLCFEM/suanPan/actions)
[![codecov](https://codecov.io/gh/TLCFEM/suanPan/branch/dev/graph/badge.svg?token=65BF9DF697)](https://codecov.io/gh/TLCFEM/suanPan)
[![codacy](https://app.codacy.com/project/badge/Grade/1ea08c43edf342a8b00b21e585e63503)](https://www.codacy.com/gh/TLCFEM/suanPan/dashboard?utm_source=github.com&utm_medium=referral&utm_content=TLCFEM/suanPan&utm_campaign=Badge_Grade)
[![CodeFactor](https://www.codefactor.io/repository/github/tlcfem/suanpan/badge)](https://www.codefactor.io/repository/github/tlcfem/suanpan)
[![language](https://img.shields.io/github/languages/count/TLCFEM/suanPan.svg?color=44cc11)](https://github.com/TLCFEM/suanPan)
[![language](https://img.shields.io/github/languages/top/TLCFEM/suanPan.svg?color=44cc11&logo=c%2B%2B)](https://github.com/TLCFEM/suanPan)
[![size](https://img.shields.io/github/languages/code-size/TLCFEM/suanPan.svg?color=44cc11)](https://img.shields.io/github/languages/code-size/TLCFEM/suanPan.svg?color=44cc11)
[![issues](https://img.shields.io/github/issues/TLCFEM/suanPan.svg?color=44cc11)](https://github.com/TLCFEM/suanPan/issues)
[![chat](https://badges.gitter.im/suanPan-dev/community.svg)](https://gitter.im/suanPan-dev/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FTLCFEM%2FsuanPan.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2FTLCFEM%2FsuanPan?ref=badge_shield)
[![gplv3-or-later](https://www.gnu.org/graphics/gplv3-or-later.svg)](https://www.gnu.org/licenses/gpl-3.0.en.html)
## Introduction
[🧮 **suanPan**](https://tlcfem.github.io/suanPan/) is a finite element method (FEM) simulation platform for
applications in fields such as solid mechanics and civil/structural/seismic engineering. The name **suanPan** (in some
places such as suffix it is also abbreviated as **suPan**) comes from the term *Suan Pan* (算盤), which
is [Chinese abacus](https://en.wikipedia.org/wiki/Suanpan). **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](https://www.3ds.com/products-services/simulia/products/abaqus/), [ANSYS](http://www.ansys.com/)
and [OpenSees](http://opensees.berkeley.edu/).
Please check the documentation [here](https://tlcfem.github.io/suanPan-manual/latest/) for command references. Please star ⭐ the project!
## Features
The highlights of **suanPan** are
- **suanPan** is *fast*, both memory and thread safe.
- **suanPan** is designed based on the [shared memory](https://en.wikipedia.org/wiki/Shared_memory) model and supports
parallelism on heterogeneous architectures, for example, multithreaded CPU + optional GPU. The parallelism is
available
for both element state updating and global matrix assembling.
- **suanPan** is open source and easy to be extended to incorporate user-defined elements, materials, etc.
- **suanPan** separates the FEA model part from the linear algebra operation part, which significantly reduces the
complexity and cost of development of new models.
- **suanPan** utilizes the new language features shipped with the latest standards (C++11 to C++20), such as new STL
containers, smart pointers, and many others.
- **suanPan** supports simple visualization supported by [VTK](https://vtk.org/).
## 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.
```bash
# 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,
```powershell
# in the folder containing suanPan.exe
.\suanPan.exe
```
First time users can use `overview` command to go through a quick introduction.
```text
+-----------------------------------------------------+
| __ __ suanPan is an open source |
| / \ | \ FEM framework (64-bit) |
| \__ |__/ __ __ Betelgeuse (2.8.0) |
| \ | | | | \ | | by tlc @ 10fd6147 |
| \__/ |__| | |__X | | all rights reserved |
| 10.5281/zenodo.1285221 |
+-----------------------------------------------------+
| https://github.com/TLCFEM/suanPan |
| https://tlcfem.github.io/suanPan-manual/latest |
+-----------------------------------------------------+
| https://gitter.im/suanPan-dev/community |
+-----------------------------------------------------+
suanPan ~<> overview
```
Sample models are available for almost all models/commands. Please check the `Example` folder for details. Further
details can be seen [here](https://tlcfem.gitbook.io/suanpan-manual/tutorial/obtain) regarding how to run model files.
## Installation
Only the 64-bit version is compiled.
It is assumed that [**AVX**](https://en.wikipedia.org/wiki/Advanced_Vector_Extensions) is available thus if the program
fails, please check if your CPU supports AVX.
### Windows
#### Binary Package
The archives of binaries are released under [Release](https://github.com/TLCFEM/suanPan/releases) page.
1. `suanpan-win-mkl-vtk.zip` is the portable version.
2. `suanpan-win-mkl-vtk.exe` is the installer.
#### Chocolatey
The binaries, which are compiled with Intel MKL and VTK, are available
on [Chocolatey](https://chocolatey.org/packages/suanpan), please use the following command to install the package.
1. Follow the [instructions](https://chocolatey.org/install) to install Chocolatey.
2. Use the following command to install `suanPan`.
```ps
choco install suanpan
```
3. It is recommended to use a modern terminal such as [Windows Terminal](https://github.com/microsoft/terminal)
and [Fluent Terminal](https://github.com/felixse/FluentTerminal) 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.
[![asciicast](https://asciinema.org/a/491350.svg)](https://asciinema.org/a/491350)
#### Scoop
It is also possible to use [Scoop](https://scoop.sh/) to install the package.
1. Install [Scoop](https://scoop.sh/).
```ps
Set-ExecutionPolicy RemoteSigned -scope CurrentUser
iwr -useb get.scoop.sh | iex
```
2. Install `suanPan`.
```ps
scoop install suanpan
```
### 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.
[![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)](https://snapcraft.io/suanpan)
[![asciicast](https://asciinema.org/a/491330.svg)](https://asciinema.org/a/491330)
#### 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/assets/badges/flathub-badge-en.svg'/></a>
```bash
# add repo
flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
# or the beta channel
# flatpak remote-add --if-not-exists flathub-beta https://flathub.org/beta-repo/flathub-beta.flatpakrepo
# install
flatpak install suanPan
# define alias
echo "alias suanpan=\"flatpak run io.github.tlcfem.suanPan\"" >> ~/.bashrc
```
#### Installation Packages
Alternatively, download the RPM (Fedora 36) or DEB (Ubuntu 22.04) package from the release page. The packages may not be
compatible with older distributions (due to different versions of `libstdc++`). It is also possible to compile the
package via docker, check the dockerfiles under the `Script` folder, for any questions please open an issue.
### Other Platforms
Precompiled binaries are provided via CI/CD on macOS, Windows, and Ubuntu.
Please download the file from the [release](https://github.com/TLCFEM/suanPan/releases) page.
A few flavors are available:
1. `vtk` --- visualisation support is enabled, with this you can record VTK files for postprocessing, however, OpenGL
may be missing on server systems
2. `mkl` --- linear algebra operations are offloaded to MKL, which gives the optimal performance on Intel chips
3. `openblas` --- linear algebra operations are offloaded to OpenBLAS, which may outperform MKL on AMD platforms
Advanced users can compile the program from source by themselves in order to enable GPU based solvers which require
an available [CUDA](https://docs.nvidia.com/cuda/cuda-toolkit-release-notes/) library.
Since CI/CD uses `GCC 11` (on Linux) and `Clang 13.0.1` (on macOS), it may be required to update/install
proper `libstdc++` (or `libc++`) version. The easiest way is to install the same compiler. For example, on Ubuntu 22.04,
```bash
# Ubuntu
sudo apt install gcc g++ gfortran libomp5
```
For VTK enabled versions, it may be necessary to install OpenGL.
```bash
# Ubuntu
sudo apt install libglu1-mesa-dev freeglut3-dev mesa-common-dev libglvnd-dev
```
### Automation Related
On Windows, a batch file named `AddAssociation.bat` is provided in the archive. It provides file associations and
prepares a proper working environment (build system, autocompletion, highlighting)
with [Sublime Text](https://www.sublimetext.com/). It also adds file associations with `.sp` and `.supan` files, please
run the `AddAssociation.bat` file with administrator privilege. [Sublime Text](https://www.sublimetext.com/)
autocompletion and syntax highlighting files are also provided. Please install Sublime Text first and execute the batch
file with the administrator privilege.
On Linux, a script file named as `suanPan.sh` is provided. By executing
```bash
./suanPan.sh --create-link
```
It adds Sublime Text autocompletion and syntax highlighting files to proper location if Sublime Text configuration
folder is found. It also adds a command alias `suanpan` to `~/.local/bin` and a desktop file
to `~/.local/share/applications`.
## Dependency
Additional libraries used in **suanPan** are listed as follows.
- [**ARPACK**](https://github.com/opencollab/arpack-ng)
- [**SPIKE**](http://www.spike-solver.org/) version 1.0
- [**FEAST**](http://www.feast-solver.org/) version 4.0
- [**SuperLU**](https://portal.nersc.gov/project/sparse/superlu/) version 5.3.0
- [**SuperLU MT**](https://portal.nersc.gov/project/sparse/superlu/) version 3.1
- [**OpenBLAS**](https://github.com/xianyi/OpenBLAS) version 0.3.21
- [**Lis**](https://www.ssisc.org/lis/) version 2.1.3
- [**TBB** Threading Building Blocks](https://github.com/oneapi-src/oneTBB) version 2021.9.0
- [**HDF5**](https://www.hdfgroup.org/solutions/hdf5/) version 1.10.6
- [**MUMPS**](https://mumps-solver.org/) version 5.6.0
- [**METIS**](http://glaros.dtc.umn.edu/gkhome/metis/metis/overview) version 5.1.0
- [**VTK**](https://vtk.org/) version 9.2.6
- [**CUDA**](https://docs.nvidia.com/cuda/cuda-toolkit-release-notes/) version 12.0
- [**MAGMA**](https://icl.utk.edu/magma/) version 2.7.1
- [**Armadillo**](http://arma.sourceforge.net/) version 12.6.3
- [**ensmallen**](https://ensmallen.org/) version 2.19.0
- [**oneMKL**](https://software.intel.com/content/www/us/en/develop/tools/oneapi/components/onemkl.html) version 2023.2.0
- [**Catch2**](https://github.com/catchorg/Catch2) version 3.4.0
- [**fmt**](https://github.com/fmtlib/fmt) version 10.1.1
- [**whereami**](https://github.com/gpakosz/whereami)
- [**exprtk**](https://github.com/ArashPartow/exprtk)
- **thread_pool** abridged version of [`thread-pool`](https://github.com/bshoshany/thread-pool)
Those libraries may depend on other libraries such as [zlib](https://zlib.net/)
and [Szip](https://support.hdfgroup.org/doc_resource/SZIP/). Additional tools may be used by **suanPan**, they are
- [**UPX** the Ultimate Packer for eXecutables](https://upx.github.io/)
## How To Compile
Please refer to the corresponding [page](https://tlcfem.github.io/suanPan-manual/latest/Basic/Compile/) in
the manual for details.
## Happy Modelling
![an example simulation of particle collision](Resource/particle-collision.gif)
## Licence
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FTLCFEM%2FsuanPan.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2FTLCFEM%2FsuanPan?ref=badge_large)
md5: 62B6387CB2D1CBFD4AD5E6429270AE4F | sha1: 451E92876CC9B0DF00FF2B81383DF489D7D88F04 | sha256: 3DBF2A3A49133DA5B37CB5D05C935DB735FC7B0EE0266801D9ACAEAFE070360F | sha512: 935AEE7FB24ADA2F31F3C38D9CA6BDCBA0230490EB74B15A36DBC9052B6480C36D0ECAE26290FEB4E685C95CF4CFB95D2D6C4EB13A089A82AEB48D2FAFA7E84C
md5: A154B4C5C2896153DC22CDAB0D917451 | sha1: 976E76A07B6B40A1B968A821477F2DEEADFD735F | sha256: 785B21A41062B7DBEEE26B100820841E88B13C4A1D8CD6E6C51BDFA8F1DADE58 | sha512: 2EFA7D30C208C5A59DDE554D2EF604212E9BE627828392A05C0BD90D366DB75512DFB71A31852C8230AF9C53E7BBE387105E882ABA1270A8E47A49B5D7E660BB
md5: B735EC9E704FC08B2851DAB973FB76D6 | sha1: 98E9AB2620D68A58A17D4881867C4C81180C9EFA | sha256: 8591CDDD35E8E6082092BC37F325C99A4A7D364BA58B9EC365ACA095050B8B44 | sha512: F3FB7E3CE9558A30C4CBF96804C8A0A47ABDDDE2A42ABCB77F3B49D4A1054AD2BCD4BB88D8B49DD928E3335294876EE99D3F715E0C480F1DE10BE33AC7CC904E
md5: 94A2CB93E09F41CB6F458F61C1ADE63B | sha1: 9B14296CD6D29A28BF9CE6A8101BC2A78E89B40D | sha256: 9ABB0767CD83B74B360CC6C590EFC18DB6BB5F23D37748570DCE20B3F3B64EDF | sha512: 2FF3982C65E57B3EF086EA1BD11BFA6514F57C5F5A92EFCC6ED0D3DBE4ABBF1F48C7EAF529E7550606C417360987333F8588DF86AC22B5D8711071CACC23B670
md5: 49C96CECDA5C6C660A107D378FDFC3D4 | sha1: 00149B7A66723E3F0310F139489FE172F818CA8E | sha256: 69320F278D90EFAAEB67E2A1B55E5B0543883125834C812C8D9C39676E0494FC | sha512: E09E072F3095379B0C921D41D6E64F4F1CD78400594A2317CFB5E5DCA03DEDB5A8239ED89905C9E967D1ACB376B0585A35ADDF6648422C7DDB472CE38B1BA60D
md5: CF0A1C4776FFE23ADA5E570FC36E39FE | sha1: 2050FADECC11550AD9BDE0B542BCF87E19D37F1A | sha256: 6FD366A691ED68430BCD0A3DE3D8D19A0CB2102952BFC140BBEF4354ED082C47 | sha512: D95CD98D22CA048D0FC5BCA551C9DB13D6FA705F6AF120BBBB621CF2B30284BFDC7320D0A819BB26DAB1E0A46253CC311A370BED4EF72ECB60C69791ED720168
VERIFICATION
To verify, please visit https://github.com/TLCFEM/suanPan/releases where the same archive is uploaded.
DEPENDENCY
libiomp5md.dll : 8a90e1e81634eae33d65d34a1bc9e02a8f424df2f3ef203069c4f2e632e6fe65
libmmd.dll : ec9db4062eb835fa250edc01267cb97edf68c70b72b085e0fcf035b064c8852d
msvcp140.dll : 74892d9b4028c05debaf0b9b5d9dc6d22f7956fa7d7eee00c681318c26792823
tbb12.dll : 785b21a41062b7dbeee26b100820841e88b13c4a1d8cd6e6c51bdfa8f1dade58
tbbmalloc.dll : 8591cddd35e8e6082092bc37f325c99a4a7d364ba58b9ec365aca095050b8b44
tbbmalloc_proxy.dll : 9abb0767cd83b74b360cc6c590efc18db6bb5f23d37748570dce20b3f3b64edf
vcruntime140.dll : 69320f278d90efaaeb67e2a1b55e5b0543883125834c812c8d9c39676e0494fc
vcruntime140_1.dll : 6fd366a691ed68430bcd0a3de3d8d19a0cb2102952bfc140bbef4354ed082c47
EXECUTABLE
suanPan.exe : 3dbf2a3a49133da5b37cb5d05c935db735fc7b0ee0266801d9acaeafe070360f
TEXT
AddAssociation.bat
suanPan.sublime-completions
suanPan.sublime-syntax
LICENSE
CHANGELOG.md
README.md
Log in or click on link to see number of positives.
- tbb12.dll (785b21a41062) - ## / 67
- tbbmalloc.dll (8591cddd35e8) - ## / 68
- tbbmalloc_proxy.dll (9abb0767cd83) - ## / 70
- msvcp140.dll (74892d9b4028) - ## / 71
- vcruntime140.dll (69320f278d90) - ## / 71
- vcruntime140_1.dll (6fd366a691ed) - ## / 71
- libiomp5md.dll (8a90e1e81634) - ## / 69
- libmmd.dll (ec9db4062eb8) - ## / 70
- suanPan.exe (c1d1f775e8b1) - ## / 64
- updater.exe (8ebfad9607f7) - ## / 65
- suanpan.3.1.0.nupkg (3250c5d35b3a) - ## / 65
- suanPan.exe (3dbf2a3a4913) - ## / 70
In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).
Chocolatey Pro provides runtime protection from possible malware.
Add to Builder | Version | Downloads | Last Updated | Status |
---|---|---|---|---|
suanPan 3.3.0 | 40 | Tuesday, January 23, 2024 | Approved | |
suanPan 3.2.0 | 32 | Monday, November 6, 2023 | Approved | |
suanPan 3.1.0 | 49 | Sunday, October 1, 2023 | Approved | |
suanPan 3.0 | 94 | Saturday, May 13, 2023 | Approved | |
suanPan 2.9 | 59 | Saturday, February 25, 2023 | Approved | |
suanPan 2.8 | 41 | Friday, January 20, 2023 | Approved | |
suanPan 2.7 | 35 | Wednesday, December 21, 2022 | Approved | |
suanPan 2.6.1 | 42 | Wednesday, November 9, 2022 | Approved | |
suanPan 2.6 | 38 | Saturday, November 5, 2022 | Approved | |
suanPan 2.5 | 49 | Friday, August 12, 2022 | Approved | |
suanPan 2.4 | 71 | Friday, June 17, 2022 | Exempted | |
suanPan 2.3 | 64 | Saturday, May 14, 2022 | Approved | |
suanPan 2.2 | 68 | Tuesday, April 5, 2022 | Approved | |
suanPan 2.1 | 81 | Sunday, February 13, 2022 | Approved | |
suanPan 2.0 | 84 | Wednesday, January 12, 2022 | Approved | |
suanPan 1.9 | 71 | Saturday, November 13, 2021 | Approved | |
suanPan 1.8 | 73 | Saturday, September 25, 2021 | Approved | |
suanPan 1.7 | 97 | Sunday, August 1, 2021 | Approved | |
suanPan 1.6 | 89 | Saturday, June 26, 2021 | Approved | |
suanPan 1.5 | 105 | Wednesday, May 26, 2021 | Approved | |
suanPan 1.4 | 78 | Saturday, April 24, 2021 | Approved | |
suanPan 1.3 | 105 | Saturday, March 20, 2021 | Approved | |
suanPan 1.2 | 121 | Friday, February 12, 2021 | Approved | |
suanPan 1.1 | 101 | Sunday, January 10, 2021 | Approved | |
suanPan 1.0 | 133 | Sunday, October 18, 2020 | Approved |
2017-2023 Theodore Chang
Please visit: https://github.com/TLCFEM/suanPan/releases
This package has no dependencies.
Ground Rules:
- This discussion is only about suanPan and the suanPan package. If you have feedback for Chocolatey, please contact the Google Group.
- This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
- The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
- Tell us what you love about the package or suanPan, or tell us what needs improvement.
- Share your experiences with the package, or extra configuration or gotchas that you've found.
- If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.