Recent Commits
Commit | Author | Details | Committed | ||||
---|---|---|---|---|---|---|---|
b8b5f49bb76d | richart | keeping old version but marking it deprecated | May 4 2022 | ||||
46de087fc5ed | richart | Changing the version from real to int to avoid exact real comparaison | May 3 2022 | ||||
e7ba0c1c0ee7 | richart | extanding python group interface | May 3 2022 | ||||
d95695ca47b4 | richart | Setting properly the model type in contact coupler | May 3 2022 | ||||
16c7f3f5d1ca | richart | Bu fix in the material selector | May 3 2022 | ||||
af35006dbf96 | richart | Creating submodule for debug and cleaning debug code | May 3 2022 | ||||
392f7c3dd293 | richart | Merge branch 'bugfixes/39-the-python-example-for-phasefield-are-broken-due-to-a… | Apr 27 2022 | ||||
489f68024a53 | richart | Adding the default argument to `setIntegrationScheme` | Apr 26 2022 | ||||
af00844e74fe | anciaux | Merge branch 'bugfixes/65-Making-the-integrators-available-in-Python' into… | Apr 8 2022 | ||||
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 |
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: