Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gha3mi/fordot
ForDot - A Fortran library that overloads the dot_product function to enable efficient dot product with/without coarray.
https://github.com/gha3mi/fordot
coarray dot-product fortran fortran-package-manager
Last synced: about 1 month ago
JSON representation
ForDot - A Fortran library that overloads the dot_product function to enable efficient dot product with/without coarray.
- Host: GitHub
- URL: https://github.com/gha3mi/fordot
- Owner: gha3mi
- License: bsd-3-clause
- Created: 2023-12-17T12:28:11.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-02T08:11:13.000Z (12 months ago)
- Last Synced: 2024-02-03T00:07:46.873Z (12 months ago)
- Topics: coarray, dot-product, fortran, fortran-package-manager
- Language: Fortran
- Homepage: https://gha3mi.github.io/fordot/
- Size: 613 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://zenodo.org/doi/10.5281/zenodo.10594970)
[](https://github.com/gha3mi/fordot)
[](https://github.com/gha3mi/fordot/releases/latest)
[](https://gha3mi.github.io/fordot/)
[](https://github.com/gha3mi/fordot/blob/main/LICENSE)
[](https://github.com/gha3mi/fordot/actions/workflows/CI_test.yml)
**ForDot**: A Fortran library that overloads the `dot_product` function to enable efficient dot product with/without coarray.
## Usage
```fortran
use fordot
a = dot_product(u,v,coarray,option,nblock)
```
- `coarray` is an optional logical variable. Set it to `.true.` and use the `-DUSE_COARRAY` flag to enable coarray.
- `nblock` is an optional integer variable.
- `options` is an optional character variable. Available options are `'m1'` to `'m4'`, and the default option is `'m2'`.
- **Note**: Use the flag `-DUSE_DO_CONCURRENT` to enable do concurrent. This implementation of do concurrent is currently only supported by the Intel Compiler (ifx).
## Requirements
- A Fortran Compiler
- BLAS Library
- Fortran Package Manager (fpm)
## fpm Dependency
If you want to use `ForDot` 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]
fordot = {git="https://github.com/gha3mi/fordot.git"}
```
## Runing Tests
Execute the following commands to run tests with specific compilers:
```shell
fpm @-test
```
`compiler: ifx, ifort, gfortran, nvfortran`
For coarray testing use:
```shell
fpm @-test-coarray
```
`compiler: ifx, ifort`
All compiler options are accessible in the fpm response file `fpm.rsp`.
## Benchmarks
You can find benchmark results on [ForBenchmark](https://github.com/gha3mi/forbenchmark/tree/main/benchmarks/dot).
## API Documentation
The most up-to-date API documentation for the master branch is available
[here](https://gha3mi.github.io/fordot/).
To generate the API documentation for `ForDot` using
[ford](https://github.com/Fortran-FOSS-Programmers/ford) run the following
command:
```shell
ford ford.yml
```
## Contributing
Contributions to `ForDot` are welcome!
If you find any issues or would like to suggest improvements, please open an issue.
## Citation
If you use `ForDot` in your work, please cite it using the following DOI:
```
@software{ghasemi_2024_10594971,
author = {Ghasemi, Seyed Ali},
title = {gha3mi/fordot: v0.1.0},
month = jan,
year = 2024,
publisher = {Zenodo},
version = {v0.1.0},
doi = {10.5281/zenodo.10594971},
url = {https://doi.org/10.5281/zenodo.10594971}
}
```