rAKA/f7d19198247bfeatures/define_public_…
features/define_public_api_in_library vs master
| Commit | Author | Details | Committed | ||||
|---|---|---|---|---|---|---|---|
| 80825ebd0d2c | Nicolas Richart | missing include | Jul 21 2023 | ||||
| e7973bc5af17 | Nicolas Richart | Adding missing symbols | Jul 21 2023 | ||||
| c177cb7917bc | Nicolas Richart | Using cmake capabilities to generate the exports | Jul 21 2023 | ||||
| f24405f1b497 | Nicolas Richart | Extra semi-colon | Jul 7 2023 | ||||
| ef4b3ac328a4 | Nicolas Richart | Forgot to remove a test | Jul 6 2023 | ||||
| a01abf074049 | Nicolas Richart | Switching to AKANTU_EXPORT and making tests and examples compile | Jul 5 2023 | ||||
| 77a2b108f953 | Nicolas Richart | remove finalize() | Jul 5 2023 | ||||
| f41e9028be9e | anciaux | introduce a set of macros to help developer defining the public api | Jun 19 2023 | ||||
| ad3fb0506067 | anciaux | remove a useless check | Jun 19 2023 | ||||
| a4b191e5a7fb | anciaux | remove a warning when compiling in debug with phasefield | Jun 16 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 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: