Recent Commits
| Commit | Author | Details | Committed | ||||
|---|---|---|---|---|---|---|---|
| 59ebe4582f96 | richart | Update CHANGELOG.md | May 5 | ||||
| 882b8698ac6c | anciaux | Merge branch 'bugfixes/all_bugs_found_by_working_on_tutorials' into 'master' | May 5 | ||||
| f9de4c21dd63 | anciaux | Merge branch 'features/adding-shape-recomputation-capability-python' into… | May 5 | ||||
| 14ba1df53331 | richart | Default urllib changed making the doc fail | May 5 | ||||
| d2b5cf6cfa3b | richart | No lint instead of inline | May 5 | ||||
| 4c27bac0c52b | richart | Bug fix in dummy shynchronizer interface | May 4 | ||||
| 9815bf3c7ce6 | richart | Wrong dimension used | May 4 | ||||
| 3983eb743993 | anciaux | Merge branch 'bugfixes/60-hybrid-phase-field-formulation-unstable-in-dynamics'… | May 4 | ||||
| ea41a8601b8b | saduruss | code formatting | May 4 | ||||
| cadd5fc53f8b | saduruss | add phase-field isotropic option | May 3 | ||||
| 5444501584d0 | richart | Merge branch 'bugfixes/macos-compilation-documentation' into 'master' | May 3 | ||||
| f7d19198247b | richart | Bug fix in Mesh::sendEvent | May 2 | ||||
| 0c70fb2d4ef4 | richart | Converter from python gmsh to akantu | May 2 | ||||
| f54488dde6c3 | hnat_lesiv | fixed type and added general MUMPS setup | May 1 | ||||
| 09f28cee1a33 | hnat_lesiv | Made more generic as per Emil's suggestions | May 1 |
README.md
Akantu: Swiss-Made Open-Source Finite-Element Library
  
Akantu means a little element in Kinyarwanda, a Bantu language. From now on it is also an open-source object-oriented library which has the ambition to be generic and efficient. Even though the code is written to be generic, Akantu strength are in solid mechanics models for fracture and contact simulations.
The full documentation can be found on ReadTheDocs
Building Akantu
Dependencies
In order to compile Akantu any compiler supporting fully C++14 should work. In addition some libraries are required:
- CMake (>= 3.5.1)
- Boost (preprocessor and Spirit)
- zlib
- Eigen3 (if not present the build system will try to download it)
For the python interface:
- Python (>=3 is recommended)
- pybind11 (if not present the build system will try to download it)
To run parallel simulations:
- MPI
- Scotch
To use the static or implicit dynamic solvers at least one of the following libraries is needed:
- MUMPS (since this is usually compiled in static you also need MUMPS dependencies)
- PETSc
To compile the tests and examples:
- Gmsh
- google-test (if not present the build system will try to download it)
On .deb based systems
sh > sudo apt install cmake libboost-dev zlib1g-dev gmsh libeigen3-dev # For parallel > sudo apt install mpi-default-dev libmumps-dev libscotch-dev # For sequential > sudo apt install libmumps-seq-dev
Configuring and compilation
Akantu is a CMake project, so to configure it, you can follow the usual way:
sh > cd akantu > mkdir build > cd build > ccmake .. [ Set the options that you need ] > make > make install
Using the python interface
You can install `Akantu` using pip, this will install a pre-compiled version:
sh > pip install akantu
You can then import the package in a python script as:
python import akantu
The python API is similar to the C++ one. If you encounter any problem with the python interface, you are welcome to do a merge request or post an issue on GitLab.
Tutorials with the python interface
To help getting started, multiple tutorials using the python interface are available as notebooks with pre-installed version of Akantu on Binder. The following tutorials are currently available: