Recent Commits
Commit | Author | Details | Committed | ||||
---|---|---|---|---|---|---|---|
522a8942da5d | Philip Mueller, HS | Fixed some compilation errors in the `python/py_integration_scheme.cc` file. | Mar 30 2022 | ||||
6864c9ffb9ca | Philip Mueller, HS | Fixed the CMake of the Python interface. | Mar 30 2022 | ||||
7c8e3eb1d349 | richart | Making IntegratorScheme available in python | Mar 18 2022 | ||||
f2068e9a8030 | richart | Merge branch 'features/missing-python-interface-for-mesh-data' into 'master' | Feb 18 2022 | ||||
0262abf49444 | richart | More typo in FindMumps | Feb 10 2022 | ||||
e2b2f0ed2cc1 | richart | Code cleaning and debuging after rebase | Feb 10 2022 | ||||
f4c285cd20f1 | richart | Modified for clang outputs | Feb 10 2022 | ||||
4153dbf7c71d | richart | Defining a Manjaro docker that has akantu dependencies | Feb 10 2022 | ||||
950df4181187 | richart | Detecting presence of pybind11 | Feb 10 2022 | ||||
6d5f097ba1eb | richart | Improving MUMPS detection | Feb 10 2022 | ||||
2c4fe29b9c9b | richart | Typo and adding non deprecated version of variables | Feb 10 2022 | ||||
b095aa804ace | richart | Forcing skip_mpi_cxx in a way to not generate a warning | Feb 10 2022 | ||||
de3f2a32afcc | richart | Forcing MPI to look only for the needed langagues | Feb 10 2022 | ||||
677ca31609cb | richart | Implemented inflate which does the opposite of flatten | Feb 10 2022 | ||||
4d99cf952ec7 | richart | Typo WARN -> WARNING | Feb 10 2022 |
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 libzlib-dev liblapack3 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:
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: