rAKA/c36866de0640features/joss-2021
features/joss-2021 vs master
Commit | Author | Details | Committed | ||||
---|---|---|---|---|---|---|---|
095d38b72423 | frerot | [JOSS] added start of statement of need | Sep 28 2022 | ||||
424c60f14df2 | frerot | [joss] typo in bib key | Sep 23 2022 | ||||
c36866de0640 | frerot | Merge branch 'master' into features/joss-2021 | Sep 23 2022 | ||||
0d7f1faf8302 | frerot | [joss] added non-exhaustive citations in summary | Sep 23 2022 | ||||
9a0a5798cb20 | frerot | [joss] added local compile script | Sep 23 2022 | ||||
4cc61439b7b6 | Nicolas Richart | Merge remote-tracking branch 'origin/master' into features/joss-2021 | Oct 29 2021 | ||||
d1ce1b5244e9 | frerot | [joss] added ref to plastic contact paper | Oct 29 2021 | ||||
e1348dbb2947 | frerot | [joss] drafted an initial paragraph | Oct 29 2021 | ||||
ae6cbb592dca | Nicolas Richart | Error in the bibtex file name | Sep 21 2021 | ||||
142b2c8b502e | Nicolas Richart | Initial commit of the JOSS paper | Sep 21 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: