rAKA/0d63565c614afeatures/solver-rewrite
features/solver-rewrite vs master
| Commit | Author | Details | Committed | ||||
|---|---|---|---|---|---|---|---|
| 182d0160df4a | anciaux | comment the non finished tests | May 7 | ||||
| 080d4ed95483 | anciaux | correcting test | May 6 | ||||
| d6134eb51e59 | anciaux | resolve typo | May 6 | ||||
| 83a977838739 | anciaux | return policy set for new function | Apr 9 | ||||
| a4abc7895a26 | anciaux | adding the getmesh feature to fe_engine | Apr 9 | ||||
| 15c33aa0b28e | anciaux | adding the new function to python interface | Mar 26 | ||||
| e6255807869c | anciaux | adding an interpolate version for all elementtype | Mar 26 | ||||
| 7b38021156ef | anciaux | Merge branch 'features/solver-rewrite' of gitlab.com:akantu/akantu into… | Mar 26 | ||||
| 397dd1ff927a | anciaux | Merge branch 'master' into features/solver-rewrite | Mar 25 | ||||
| d31eb97ffe94 | anciaux | saving the change of interface | Mar 25 |
/
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.
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
- blas/lapack
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 liblapack-dev libblas-dev gmsh # For parallel > sudo apt install mpi-default-dev libmumps-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: