https://github.com/gha3mi/fordebug
ForDebug: A Fortran library designed for debugging Fortran code, especially within pure procedures.
https://github.com/gha3mi/fordebug
elapsed-time elemental fortran-package-manager pure
Last synced: about 2 months ago
JSON representation
ForDebug: A Fortran library designed for debugging Fortran code, especially within pure procedures.
- Host: GitHub
- URL: https://github.com/gha3mi/fordebug
- Owner: gha3mi
- License: bsd-3-clause
- Created: 2023-12-12T20:17:27.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-04T20:11:00.000Z (about 1 year ago)
- Last Synced: 2025-02-06T04:51:26.510Z (3 months ago)
- Topics: elapsed-time, elemental, fortran-package-manager, pure
- Language: Fortran
- Homepage: https://gha3mi.github.io/fordebug/
- Size: 659 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/gha3mi/fordebug)
[](https://github.com/gha3mi/fordebug/releases/latest)
[](https://gha3mi.github.io/fordebug/)
[](https://github.com/gha3mi/fordebug/actions/workflows/CI_test.yml)
[](https://github.com/gha3mi/fordebug/actions/workflows/CI_doc.yml)
[](https://github.com/gha3mi/fordebug/blob/main/LICENSE)
**ForDebug**: A Fortran library designed for debugging Fortran code, especially within pure procedures.
**USE OF THIS LIBRARY IS NOT STANDARDS CONFORMING AND YOU CAN EXPECT THINGS TO BREAK IN PLENTY OF SITUATIONS. IT SHOULD BE USED ONLY FOR DEBUGGING PURPOSES**
- [fpm dependency](#fpm-dependency)
- [How to run demo](#how-to-run-demo)
- [API documentation](#api-documentation)
- [Contributing](#contributing)
## fpm dependency
If you want to use `ForDebug` 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]
fordebug = {git="https://github.com/gha3mi/fordebug.git"}
```
## Usage
### Printing or Writing within Pure Procedures
To enable printing or writing within a pure procedure in Fortran, use the fordebug module.
```Fortran
use fordebug
! within pure procedures
call pwrite(message='hello!')
call pwrite(R0i32=n)
call pwrite(message='x = ', R0r32=10.0, format='(a,f7.3)', file='example/demo.txt', access='append')
```
#### Notes
- All arguments of `pwrite` are optional.
- Data types are represented using the following conventions:
- `R0i32`, `R0i64`, `R0r32`, `R0r64`, `R0c32`, `R0c64` for Rank 0 integer, real, and complex types.
- `R1i32`, `R1i64`, `R1r32`, `R1r64`, `R1c32`, `R1c64` for Rank 1 integer, real, and complex types.
- `R2i32`, `R2i64`, `R2r32`, `R2r64`, `R2c32`, `R2c64` for Rank 2 integer, real, and complex types.
- `R0ch` for Rank 0 character.
### Measuring Elapsed Time within Pure Procedures
ForDebug uses [ForTmie](https://github.com/gha3mi/fortime) as dependency. For measuring elapsed time within a pure procedure, utilize the fordebug module with time derived type.
```Fortran
use fordebug
type(timer) :: t
call ptimer_start(t)
! Perform your operations here
call ptimer_stop(t) ! Output: Elapsed time: 0.000 [s]
```
## How to run demo
**Clone the repository:**
Clone the `ForDebug` repository from GitHub using the following command:
```shell
git clone https://github.com/gha3mi/fordebug.git
```
Navigate to the cloned directory:
```shell
cd fordebug
```
### Running `demo`
To run `demo`, execute the following command:
```shell
fpm run --example demo
```
## API documentation
The most up-to-date API documentation for the master branch is available
[here](https://gha3mi.github.io/fordebug/).
To generate the API documentation for `ForDebug` using
[ford](https://github.com/Fortran-FOSS-Programmers/ford) run the following
command:
```shell
ford ford.yml
```
## Contributing
Contributions to `ForDebug` are welcome!
If you find any issues or would like to suggest improvements, please open an issue.
## Acknowledgment
This project draws inspiration from https://github.com/plevold/fortran-debug-utils.