ForEig: A Fortran library for eigenvalue and eigenvector calculations.

Usage

use foreig, only: eig

call eig(A, eig_vec, eig_val ,method='ggev') ! method='syev' .or. 'geev' .or. 'ggev'

fpm dependency

If you want to use ForEig as a dependency in your own fpm project, you can easily include it by adding the following line to your fpm.toml file:

[dependencies]
forieig = {git="https://github.com/gha3mi/forieig.git"}

How to run tests

Reuirements:

Fortran Compiler, LAPACK or MKL Libraries

Clone the repository:

You can clone the ForEig repository from GitHub using the following command:

git clone https://github.com/gha3mi/forieig.git

cd forieig

Intel Fortran Compiler (ifort)

fpm @ifort-test

Intel Fortran Compiler (ifx)

fpm @ifx-test

GNU Fortran Compiler (gfortran)

fpm @gfortran-test

NVIDIA Compiler (nvfortran)

fpm @nvfortran-test

API documentation

The most up-to-date API documentation for the master branch is available here. To generate the API documentation for ForEig using ford run the following command:

ford ford.yml

Contributing

Contributions to ForEig are welcome! If you find any issues or would like to suggest improvements, please open an issue.