https://github.com/gha3mi/forpca
ForPCA - A Fortran library for principal component analysis (PCA).
https://github.com/gha3mi/forpca
fortran fortran-package-manager pca principal-component-analysis
Last synced: about 1 month ago
JSON representation
ForPCA - A Fortran library for principal component analysis (PCA).
- Host: GitHub
- URL: https://github.com/gha3mi/forpca
- Owner: gha3mi
- License: bsd-3-clause
- Created: 2023-07-11T16:43:24.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-13T14:28:04.000Z (over 1 year ago)
- Last Synced: 2025-02-06T04:51:27.708Z (3 months ago)
- Topics: fortran, fortran-package-manager, pca, principal-component-analysis
- Language: Fortran
- Homepage: https://gha3mi.github.io/forpca/
- Size: 694 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/gha3mi/forpca)
[](https://github.com/gha3mi/forpca/releases/latest)
[](https://gha3mi.github.io/forpca/)
[](https://github.com/gha3mi/forpca/blob/main/LICENSE)
[](https://github.com/gha3mi/forpca/actions/workflows/CI_test.yml)
**ForPCA**: A Fortran library for principal component analysis (PCA).
## Usage
```Fortran
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:
```toml
[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:
```shell
git clone https://github.com/gha3mi/forpca.git
```
```shell
cd forpca
```
**Intel Fortran Compiler (ifort)**
```shell
fpm @ifort-test
```
```shell
fpm @ifort-test-coarray
```
**Intel Fortran Compiler (ifx)**
```shell
fpm @ifx-test
```
```shell
fpm @ifx-test-coarray
```
**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/forpca/).
To generate the API documentation for `ForPCA` using
[ford](https://github.com/Fortran-FOSS-Programmers/ford) run the following
command:
```shell
ford ford.yml
```
## Contributing
Contributions to `ForPCA` are welcome!
If you find any issues or would like to suggest improvements, please open an issue.