rAKA/ea41a8601b8bfeatures/ci_on_macos
features/ci_on_macos vs master
Commit | Author | Details | Committed | ||||
---|---|---|---|---|---|---|---|
c29b835057fe | richart | Rules for python packages fix | Dec 12 2023 | ||||
45c47c3970b2 | richart | Doubled key after merge | Dec 12 2023 | ||||
d629304583e4 | richart | Merge remote-tracking branch 'origin/master' into features/ci_on_macos | Dec 12 2023 | ||||
78b1691a99aa | richart | Linting for the code quality | Dec 8 2023 | ||||
a0c9c9a09dc3 | richart | Merge remote-tracking branch 'origin/master' into features/ci_on_macos | Dec 7 2023 | ||||
9b09f2c34e33 | richart | Installing gmsh with apt instead of pip install | Dec 5 2023 | ||||
547e0214d1d2 | richart | adding gmsh for python tests | Nov 30 2023 | ||||
f46c447f2b65 | richart | Missing variable | Nov 29 2023 | ||||
3c69f36f2239 | richart | Wrong policy due to copy-paste | Nov 29 2023 | ||||
879053f3c296 | richart | This time it should be ok with spack in cache | Nov 29 2023 |
/
README.md
Akantu: Swiss-Made Open-Source Finite-Element Library
![joss](https://joss.theoj.org/papers/3abf3c7945cc9a016a946ce9e02e357f) ![license](https://www.gnu.org/licenses/lgpl-3.0.en.html) ![readthedoc](https://akantu.readthedocs.io/en/latest/?badge=master)
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 ambition to be generic and efficient. Even though the code is written to be generic, Akantu strength are in solid mechanics models for fracture and contact simulations.
The full documentation can be found on ReadTheDocs
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
- Eigen3 (if not present the build system will try to download it)
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 gmsh libeigen3-dev # For parallel > sudo apt install mpi-default-dev libmumps-dev libscotch-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: