https://github.com/gha3mi/foreig
ForEig - A Fortran library for eigenvalue and eigenvector calculations.
https://github.com/gha3mi/foreig
eig eigenvalues eigenvalues-and-eigenvectors eigenvectors fortran fortran-package-manager lapack mkl
Last synced: about 1 month ago
JSON representation
ForEig - A Fortran library for eigenvalue and eigenvector calculations.
- Host: GitHub
- URL: https://github.com/gha3mi/foreig
- Owner: gha3mi
- License: bsd-3-clause
- Created: 2023-07-11T16:39:39.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-28T12:52:05.000Z (almost 2 years ago)
- Last Synced: 2025-02-06T04:51:27.397Z (9 months ago)
- Topics: eig, eigenvalues, eigenvalues-and-eigenvectors, eigenvectors, fortran, fortran-package-manager, lapack, mkl
- Language: Fortran
- Homepage: https://gha3mi.github.io/foreig/
- Size: 641 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/gha3mi/foreig)
[](https://github.com/gha3mi/foreig/releases/latest)
[](https://gha3mi.github.io/foreig/)
[](https://github.com/gha3mi/foreig/blob/main/LICENSE)
[](https://github.com/gha3mi/foreig/actions/workflows/ci.yml)
**ForEig**: A Fortran library for eigenvalue and eigenvector calculations.
## Usage
```Fortran
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:
```toml
[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:
```shell
git clone https://github.com/gha3mi/forieig.git
```
```shell
cd forieig
```
**Intel Fortran Compiler (ifort)**
```shell
fpm @ifort-test
```
**Intel Fortran Compiler (ifx)**
```shell
fpm @ifx-test
```
**GNU Fortran Compiler (gfortran)**
```shell
fpm @gfortran-test
```
**NVIDIA Compiler (nvfortran)**
```shell
fpm @nvfortran-test
```
## API documentation
The most up-to-date API documentation for the master branch is available
[here](https://gha3mi.github.io/forieig/).
To generate the API documentation for `ForEig` using
[ford](https://github.com/Fortran-FOSS-Programmers/ford) run the following
command:
```shell
ford ford.yml
```
## Contributing
Contributions to `ForEig` are welcome!
If you find any issues or would like to suggest improvements, please open an issue.