Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/FEniCS/dolfinx
Next generation FEniCS problem solving environment
https://github.com/FEniCS/dolfinx
fenicsx finite-element-methods parallel-computing partial-differential-equations
Last synced: 3 months ago
JSON representation
Next generation FEniCS problem solving environment
- Host: GitHub
- URL: https://github.com/FEniCS/dolfinx
- Owner: FEniCS
- License: lgpl-3.0
- Created: 2018-04-05T14:02:41.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2024-04-13T12:28:21.000Z (9 months ago)
- Last Synced: 2024-04-14T06:47:52.673Z (9 months ago)
- Topics: fenicsx, finite-element-methods, parallel-computing, partial-differential-equations
- Language: C++
- Homepage: https://fenicsproject.org
- Size: 62.8 MB
- Stars: 650
- Watchers: 47
- Forks: 171
- Open Issues: 94
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog.rst
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: COPYING
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Authors: AUTHORS
Awesome Lists containing this project
- awesome-fluid-dynamics - FEniCS/dolfinx - Next generation FEniCS problem solving environment.   (Computational Fluid Dynamics / Finite Element Methods (FEM))
README
# DOLFINx
[](https://github.com/FEniCS/dolfinx/actions/workflows/ccpp.yml)
[](https://github.com/FEniCS/dolfinx/actions/workflows/docker-end-user.yml)
[](https://github.com/FEniCS/dolfinx/actions/workflows/spack.yml)
[](https://github.com/FEniCS/dolfinx/actions/workflows/conda.yml)
[](https://github.com/FEniCS/dolfinx/actions/workflows/macos.yml)
[](https://github.com/FEniCS/dolfinx/actions/workflows/windows.yml)
DOLFINx is the computational environment of
[FEniCSx](https://fenicsproject.org) and implements the FEniCS Problem
Solving Environment in C++ and Python. DOLFINx is a new version of
DOLFIN and is actively developed.
## Documentation
Documentation can be viewed at .
## Installation
### From source
#### C++ core
To build and install the C++ core, in the `cpp/` directory, run:
```shell
mkdir build
cd build
cmake ..
make install
```
#### Python interface
To install the Python interface, first install the C++ core, and then in
the `python/` directory run:
```shell
pip install -r build-requirements.txt
pip install --check-build-dependencies --no-build-isolation .
```
For detailed instructions, see
.
### Spack
Spack is recommended for building DOLFINx on HPC systems. To build the
most recent release using [Spack](https://spack.readthedocs.io/)
(assuming a bash-compatible shell):
```shell
git clone https://github.com/spack/spack.git
. ./spack/share/spack/setup-env.sh
spack env create fenicsx-env
spack env activate fenicsx-env
spack add fenics-dolfinx+adios2 py-fenics-dolfinx cflags="-O3" fflags="-O3"
spack install
```
See the Spack [documentation](https://spack.readthedocs.io/) for
comprehensive instructions.
### Binary
**Recommendations**
- macOS: [conda](#conda).
- Linux: [apt](#ubuntu-packages)
([Ubuntu](#ubuntu-packages)/[Debian](#debian-packages)),
[docker](#docker-images) or [conda](#conda). See also [Spack](#spack).
- Windows: [docker](#docker-images), or install
[WSL2](https://docs.microsoft.com/en-us/windows/wsl/install) and use
[Ubuntu](#ubuntu-packages). [conda](#conda) packages in beta testing.
- High performance computers: [Spack](#spack) or
[from source](#from-source), both using system-provided MPI.
#### conda
To install the latest release of the Python interface, with pyvista
support for visualisation, using [conda](https://conda.io):
```shell
conda create -n fenicsx-env
conda activate fenicsx-env
conda install -c conda-forge fenics-dolfinx mpich pyvista
```
Windows conda packages are currently in beta testing and can be installed using:
```shell
conda create -n fenicsx-env
conda activate fenicsx-env
conda install -c minrk/label/fenics-windows -c conda-forge fenics-dolfinx=0.9.0.dev
```
Because FEniCS uses just-in-time compilation it also necessary to install
[Microsoft Visual Studio](https://visualstudio.microsoft.com/downloads/).
conda is distributed with [Anaconda](https://www.anaconda.com/) and
[Miniconda](https://docs.conda.io/en/latest/miniconda.html). The recipe
is hosted on
[conda-forge](https://github.com/conda-forge/fenics-dolfinx-feedstock).
| Name | Downloads | Version | Platforms |
| --- | --- | --- | --- |
| [](https://anaconda.org/conda-forge/fenics-dolfinx) | [](https://anaconda.org/conda-forge/fenics-dolfinx) | [](https://anaconda.org/conda-forge/fenics-dolfinx) | [](https://anaconda.org/conda-forge/fenics-dolfinx) |
#### Ubuntu packages
The [Ubuntu
PPA](https://launchpad.net/~fenics-packages/+archive/ubuntu/fenics)
provides FEniCSx packages. To install:
```shell
add-apt-repository ppa:fenics-packages/fenics
apt update
apt install fenicsx
```
When a version of DOLFINx is released we aim to provide a package for
the most recent LTS version of Ubuntu. All other versions are provided
on a best-effort basis.
#### Debian packages
[DOLFINx](https://tracker.debian.org/pkg/fenics-dolfinx) is included
with [various
versions](https://packages.debian.org/search?keywords=python3-dolfinx&searchon=names&exact=1&suite=all§ion=all)
of Debian. Install with `apt-get install fenicsx`.
#### Docker images
To run a Docker image with the latest release of DOLFINx:
```shell
docker run -ti dolfinx/dolfinx:stable
```
To switch between real and complex builds of DOLFINx/PETSc.
```shell
source /usr/local/bin/dolfinx-complex-mode
source /usr/local/bin/dolfinx-real-mode
```
A Jupyter Lab environment with the latest release of DOLFINx:
```shell
docker run --init -ti -p 8888:8888 dolfinx/lab:stable # Access at http://localhost:8888
```
A Docker image with DOLFINx built nightly:
```shell
docker run -ti dolfinx/dolfinx:nightly
```
A development image with all of the dependencies required to build the
latest release of the FEniCSx components:
```shell
docker run -ti dolfinx/dev-env:stable
```
A development image with all of the dependencies required
to build the `main` branch of the FEniCSx components:
```shell
docker run -ti dolfinx/dev-env:current
```
The Docker images support arm64 and amd64 architectures. For a full list
of tags, including versioned images, see
## Contributing
Information about how to contribute to DOLFINx can be found
[here](CONTRIBUTING.md).
## License
DOLFINx is free software: you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
DOLFINx is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with DOLFINx. If not, see
.
## Contact
For questions about using DOLFINx, visit the FEniCS Discourse page:
or use the FEniCS Slack channel:
(use to sign up)
For bug reports visit: