Desctiption
TODO
Supported OSes, compilers and library versions
Please note that not pre-compiled binary is provided at the moment, you will have to follow the instructions below for compiling the software.
The following are required dependancies for the building process:
-
CMake is a required on all platforms for building the software ; try to install it using a package manager (or via a manual download), as compiling it is quite time consuming.
-
Eigen is a header-only C++ library, you can either install it from a repository or download the sources from the official website : http://eigen.tuxfamily.org/index.php?title=Main_Page#Download
-
A C++ compiler, at least capable of generating code according to the C++14 standard (see https://en.wikipedia.org/wiki/C%2B%2B14) ; below are listed development platforms (Operating System + compiler toolset) on wich the software was successfully built.
Linux
Ubuntu 16.04 (x64):
- Eigen 3.2.92 (installed with apt )
- g++ (Ubuntu 5.4.0-6ubuntu1~16.04.10) 5.4.0 20160609 (installed with apt )
Ubuntu 18.04 (x64):
- Eigen 3.3.4 (installed with apt)
- g++ (Ubuntu 7.3.0-27ubuntu1~18.04) 7.3.0 (installed with apt)
- clang version 7.0.0-3~ubuntu0.18.04.1 (tags/RELEASE_700/final) (installed with apt)
BSDs
You can either use the provided package manager pkg or build packages from source using the /usr/ports mechanism; see the FreeBSD Handbook for more details.
FreeBSD 11.12 (x64):
- Eigen 3.3.7 (installed from pkg)
- clang version 6.0.0 (tags/RELEASE_600/final 326565) (installed with pkg)
macOS
On macOS see https://brew.sh/ for installing the brew package manager.
macOS 10.13 (x64):
- Eigen 3.3.7 (installed using brew)
- Apple LLVM version 9.0.0 (clang-900.0.39.2) (available from the Xcode cmd line tools)
Windows
Untested
Continuous Integration (CI)
The numdiff tool can be used for comparing the obtained NEF++ solution to reference MATLAB solutions stored in directory ressources ; this is done when non-regression tests are performed during the CI procedure.
If numdiff is not available from your package manager it can be downloaded here: http://ftp.igh.cnrs.fr/pub/nongnu/numdiff/numdiff-5.9.0.tar.gz