rAKA/fbdc646afed3features/changes-to…
features/changes-to-address-joss-review vs master
Commit | Author | Details | Committed | ||||
---|---|---|---|---|---|---|---|
a5467275fbe5 | richart | some cleaning | Aug 29 2023 | ||||
905314e6fef9 | richart | Reordering the examples to make more sense in the doc | Jun 21 2023 | ||||
8124f2deb44d | richart | Correcting problems with math_jax3 plus minor fixes | Jun 21 2023 | ||||
36e99c8d815f | richart | MathJax changed for mathjax3 | Jun 21 2023 | ||||
780668b881da | richart | Restructuring the doc to merge readme and getting started | Jun 20 2023 | ||||
e0a38591f38b | richart | Adapting changelog | Jun 20 2023 | ||||
74b0a0cb12f7 | richart | Changeing Changelog to link in the doc | Jun 20 2023 | ||||
82cc1d403955 | richart | Cleaning a bit the changelog | Jun 20 2023 | ||||
2d1181cd8a54 | richart | switching rules to only/expect | Jun 20 2023 | ||||
56b661227d87 | richart | Removing deprecated file | Jun 20 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: