rAKA/dc091c8cf015bugfixes/missing_inform…
bugfixes/missing_information_in_doc vs master
Commit | Author | Details | Committed | ||||
---|---|---|---|---|---|---|---|
90221c6b6774 | richart | Linting | Dec 11 2023 | ||||
d92c9b791a98 | richart | Other header missing | Dec 8 2023 | ||||
06959424dbad | richart | Missing header | Dec 8 2023 | ||||
d5c55a7eb987 | richart | remove debug | Dec 7 2023 | ||||
e29cd80954e9 | richart | Debugging git diff in merge request pipeline | Dec 7 2023 | ||||
526020fc5419 | richart | Trying more rules... | Dec 7 2023 | ||||
9ed7dcd241d8 | richart | Modified rules:changes:compare_to | Dec 7 2023 | ||||
34467bdc1f55 | richart | Switching to merge request pipelines | Dec 7 2023 | ||||
67246a91b23f | richart | Merge remote-tracking branch 'origin/master' into… | Dec 7 2023 | ||||
04d8e11f39a3 | richart | Trying more adaptation of the rules:changes | Dec 7 2023 |
/
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 ambi- tion 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: