README.adoc

:imagesdir: pics [.text-center] image::ElmerLogoPlain64x64.png[float="right"] == Elmer FEM

This is the official source code repository for the Elmer FEM software suite.

Elmer is a tool that can solve a large number of partial differential equations making it an ideal tool for multiphysical problems. It includes models for structural mechanics, fluid dynamics, heat transfer, electromagnetics and beyond. Elmer can be used from PCs to massively parallel HPC platforms.

[.text-center] image:https://github.com/ElmerCSC/elmerfem/actions/workflows/build.yaml/badge.svg["Builds",link=https://github.com/ElmerCSC/elmerfem/actions/workflows/build.yaml]

[.text-center] image:https://img.shields.io/github/stars/ElmerCSC/elmerfem.svg?style=social&label=Stars&style=plastic["GitHub stars"] image:https://img.shields.io/github/watchers/ElmerCSC/elmerfem.svg?style=social&label=Watch&style=plastic["GitHub watchers"] image:https://img.shields.io/github/forks/ElmerCSC/elmerfem.svg?style=social&label=Fork&style=plastic["GitHub forks"]

[.text-center] image:https://img.shields.io/github/contributors/ElmerCSC/elmerfem.svg?style=flat["GitHub contributors"] image:https://img.shields.io/github/issues-pr/ElmerCSC/elmerfem.svg?style=flat["GitHub pull requests", link=https://github.com/ElmerCSC/elmerfem/pulls] image:https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat[]

[.text-center] image:https://img.shields.io/github/last-commit/ElmerCSC/elmerfem.svg?style=flat["GitHub last commit"] image:https://img.shields.io/github/issues-raw/ElmerCSC/elmerfem.svg?maxAge=25000["Issues", link=https://github.com/ElmerCSC/elmerfem/issues] // image:https://img.shields.io/github/languages/count/ElmerCSC/elmerfem[GitHub language count]

[.text-center] image:https://img.shields.io/badge/sqaaas%20software-silver-lightgrey?style=flat["SQAaaS silver badge achieved", link=https://api.eu.badgr.io/public/assertions/DMhrwLxzQI-DBp_D7n89OQ] image:https://zenodo.org/badge/DOI/10.5281/zenodo.7892181.svg?style=social&label=Fork&style=plastic["Zenodo DOI",link=https://doi.org/10.5281/zenodo.7892181]

=== Elmer Homepages

• Official home at CSC: http://www.csc.fi/elmer[http://www.csc.fi/elmer]
• Elmer community: http://www.elmerfem.org/[http://www.elmerfem.org/]
• Elmer/Ice community: http://elmerice.elmerfem.org[http://elmerice.elmerfem.org]

=== Direct links

• Pre-compiled builds: https://github.com/ElmerCSC/elmer-wsl[WSL distro], http://www.nic.funet.fi/pub/sci/physics/elmer/bin/windows[Windows Installers], http://www.nic.funet.fi/pub/sci/physics/elmer/bin/VirtualMachines/[VirtualBox VM]
• Ubuntu Launchpad: https://launchpad.net/~elmer-csc-ubuntu/+archive/ubuntu/elmer-csc-ppa[PPA]
• Compilation: https://github.com/ElmerCSC/elmerfem/blob/devel/compilation_instructions/Ubuntu.md[Linux/Ubuntu], https://github.com/ElmerCSC/elmerfem/blob/devel/compilation_instructions/nix.md[Nix], https://github.com/ElmerCSC/elmerfem/blob/devel/compilation_instructions/Windows-msys2.md[Windows/msys2], https://github.com/ElmerCSC/elmerfem/blob/devel/compilation_instructions/macOS.md[macOS]
• Docker: https://github.com/ElmerCSC/elmerfem/blob/devel/docker/elmer.dockerfile[GitHub], nwrichmond/elmerice: https://hub.docker.com/r/nwrichmond/elmerice/[Docker Hub] // * unifem/Elmer-desktop: https://github.com/unifem/Elmer-desktop[GitHub] // * CoSci-LLC/docker-elmerice: https://hub.docker.com/repository/docker/coscillc/elmerice[Docker Hub], https://github.com/CoSci-LLC/docker-elmerice[GitHub]
• Manuals and Tutorials (about 900 pages!): http://www.nic.funet.fi/pub/sci/physics/elmer/doc/[PDF]
• image:https://img.shields.io/badge/License-GPLv2-blue.svg["License: GPL v2", link=https://www.gnu.org/licenses/gpl-2.0] image:https://img.shields.io/badge/License-LGPL%20v2.1-blue.svg["License: LGPL v2.1", link=https://www.gnu.org/licenses/lgpl-2.1] link:license_texts/ElmerLicensePolicy.md[Elmer license policy].
• List of references for citing Elmer: https://research.csc.fi/web/elmer/white-papers[White Papers]

=== Discussion and Media

• http://www.elmerfem.org/forum/[phpBB] Discussion forum, preferred place for questions with long history!
• https://www.youtube.com/user/elmerfem[Youtube], webinars and random animations
• Elmer on Twitter: image:https://img.shields.io/twitter/follow/elmerfem.svg?style=social["Twitter Follow", link=https://twitter.com/elmerfem] image:https://img.shields.io/twitter/follow/ElmerIce1.svg?style=social["Twitter Follow", link=https://twitter.com/ElmerIce1]
• Elmer on LinkedIn: image:https://i.stack.imgur.com/gVE0j.png["LinkedIn badge", link=https://www.linkedin.com/groups/3682354/], networking oriented
• https://discordapp.com/invite/NeZEBZn[Discord], generic random discussions on engineering software.
• Elmer on Reddit (low traffic, no support): image:https://img.shields.io/reddit/subreddit-subscribers/ElmerFEM["Subreddit subscribers", link=https://www.reddit.com/r/ElmerFEM/]
• https://postit.csc.fi/sympa/info/elmerupdates[ElmerUpdates], low traffic mailing list