rAKA/d86a596bd18ffeatures/ci_code_quality
features/ci_code_quality vs master
Commit | Author | Details | Committed | ||||
---|---|---|---|---|---|---|---|
29b38ed9d8b2 | richart | Adding sphinxcontrib bibtex to the docker image | Feb 18 2021 | ||||
501b6d6c02fe | richart | Reducing checks to make it faster | Feb 9 2021 | ||||
54d82a320a74 | richart | Improving a bit the code | Feb 9 2021 | ||||
528dc41f36f2 | richart | Cleaning the linting code | Feb 8 2021 | ||||
651eb6190965 | richart | More work on the code quality | Feb 8 2021 | ||||
2eb3fb8f6552 | richart | Debugging the runner for clang-tidy | Feb 7 2021 | ||||
e07de51f2975 | richart | Parse all files | Feb 7 2021 | ||||
d207e392d3b4 | richart | Trying to activate dev engines | Feb 7 2021 | ||||
e6f19dfbdaa2 | richart | Adding clang-tidy to code-quality | Feb 6 2021 | ||||
40ebd9dc36da | richart | trying to improve code quality report | Feb 5 2021 |
/
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: