Skip to content
/ forpca Public

ForPCA - A Fortran library for principal component analysis (PCA).

License

Notifications You must be signed in to change notification settings

gha3mi/forpca

Repository files navigation

GitHub Version Documentation License Build

ForPCA

ForPCA: A Fortran library for principal component analysis (PCA).

Usage

use forpca, only: tpca
type(tpca) :: p

call p%pca(matrix, npc, method, coeff, score, latent, explained, matrix_app)

call p%finalize() ! finalize

fpm dependency

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

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

How to run tests

Reuirements:

Fortran Compiler, LAPACK or MKL Libraries

Clone the repository:

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

git clone https://github.com/gha3mi/forpca.git
cd forpca

Intel Fortran Compiler (ifort)

fpm @ifort-test
fpm @ifort-test-coarray

Intel Fortran Compiler (ifx)

fpm @ifx-test
fpm @ifx-test-coarray

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 ForPCA using ford run the following command:

ford ford.yml

Contributing

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