rAKA/8f70816b5e8cfeatures/joss-2023
features/joss-2023 vs master
Commit | Author | Details | Committed | ||||
---|---|---|---|---|---|---|---|
625d1ff18c4b | richart | Typos correction | Sep 29 2023 | ||||
749be316a695 | richart | reodrering images | Sep 27 2023 | ||||
64d9803a941a | richart | Improving the statement of need and adding numerical setup image | Sep 27 2023 | ||||
a660792ba1f7 | richart | Merge branch 'master' into features/joss-2023 | Jun 20 2023 | ||||
58bbc4496e6c | Nicolas Richart | missing figure | Jun 20 2023 | ||||
e659b727b98e | richart | Sorry Shenghan for the typo in you name | Mar 30 2023 | ||||
7297d7cb24b6 | richart | [joss] adding missing DOIs | Mar 7 2023 | ||||
824c9d73f777 | Nicolas Richart | [joss] applying JF feedbacks | Feb 28 2023 | ||||
70da3955dbca | richart | [joss] adding orcid | Feb 25 2023 | ||||
e452ad3293d9 | Nicolas Richart | [joss] reorder papers | Feb 24 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 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: