diff --git a/README.md b/README.md index f1aeb98fa4fcf3d6354873f35b053aa6c39a7627..8896b12177ec1532e69d64f1748b81f140123643 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,20 @@ # dune-codegen dune-codegen is an active research project with the goal of -generating high-performance integration kernels for dune-pdelab. +generating high-performance integration kernels for the Dune project. -**Note**: Due to the research character of the code things will change -a lot and there is no guarantee for interface stability ;). +It currently provides the following features: +* Robust generation of integration kernels from the Unified Form Language (UFL) for use with dune-pdelab. +* Integration of a code generation workflow into the Dune CMake build system +* Code generation of DG methods exploiting finite element tensor product structure (sum factorization) +* Code generation for block-structured FEM - -[](https://gitlab.dune-project.org/dominic/dune-codegen/commits/master) +[](https://gitlab.dune-project.org/extensions/dune-codegen/commits/master) ## Dependencies -dune-codegen depends on the following software packages: +dune-codegen currently depends on the following software packages: * You need a working [dune-pdelab][1]. @@ -27,13 +29,13 @@ dune-codegen depends on the following software packages: We use several submodules so you should clone with the `--recursive` option: ``` -git clone --recursive ssh://git@gitlab.dune-project.org:22022/dominic/dune-codegen.git +git clone --recursive ssh://git@gitlab.dune-project.org:22022/extensions/dune-codegen.git ``` or ``` -git clone --recursive https://gitlab.dune-project.org/dominic/dune-codegen.git +git clone --recursive https://gitlab.dune-project.org/extensions/dune-codegen.git ``` If you have a feature branch `feature/my-branch` where you change the @@ -101,6 +103,7 @@ make build_tests ctest ``` +Note that this takes quite a while. ## Links