Code Monkey home page Code Monkey logo

dolfinx's Introduction

DOLFINX

Actions CI tests CircleCI Actions Docker environment images Actions Docker image builds Actions Spack build

DOLFINX is a new version of DOLFIN. It is being actively developed and features may come and go as development proceeds.

DOLFINX is the computational environment of FEniCS and implements the FEniCS Problem Solving Environment in Python and C++.

Documentation

Documentation can be viewed at:

Installation

From source

C++ core

To build and install the C++ core, in the cpp/ directory, run::

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::

pip install .

(you may need to use pip3, depending on your system).

For detailed instructions, see the file INSTALL.

Spack

To build using Spack (assuming a bash 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
echo "  concretization: together" >> ./spack/var/spack/environments/fenicsx-env/spack.yaml
spack add py-fenics-dolfinx ^petsc+mumps+hypre cflags="-O3" fflags="-O3"
spack install

See the Spack documentation for comprehensive instructions.

Docker images

A Docker image with DOLFINX built nightly:

docker run -ti dolfinx/dolfinx

To switch between real and complex builds of DOLFINX.

source /usr/local/bin/dolfinx-complex-mode
source /usr/local/bin/dolfinx-real-mode

A Jupyter Lab environment with DOLFINX built nightly:

docker run -ti -p 8888:8888 dolfinx/lab # Access at http://localhost:8888

A development image with all of the dependencies required to build DOLFINX:

docker run -ti dolfinx/dev-env

For more information, see https://hub.docker.com/u/dolfinx

License

DOLFIN-X 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.

DOLFIN-X 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 DOLFIN-X. If not, see http://www.gnu.org/licenses/.

Contact

For questions about using DOLFIN-X, visit the FEniCS Discourse page:

https://fenicsproject.discourse.group/

For bug reports, visit the DOLFIN-X GitHub page:

https://github.com/FEniCS/dolfinx

For comments and requests, send an email to the FEniCS mailing list:

[email protected]

For questions related to obtaining, building or installing DOLFIN-X, send an email to the FEniCS support mailing list:

[email protected]

dolfinx's People

Contributors

garth-wells avatar anderslogg avatar chrisrichardson avatar johanhake avatar blechta avatar johannesring avatar meg-simula avatar skavhaug avatar kent-and avatar pefarrell avatar nate-sime avatar tormodlandet avatar michalhabera avatar jobh avatar jhale avatar igorbaratta avatar solveigm avatar jorgensd avatar quang-ha avatar ivanyashchuk avatar nschloe avatar cianwilson avatar mmorandi avatar ettieunwin avatar cmaurini avatar tianyikillua avatar aslakbergersen avatar francesco-ballarin avatar mikaem avatar magneano avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.