Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/urbanjost/m_stopwatch
package for measuring cpu and wall clock execution time
https://github.com/urbanjost/m_stopwatch
cputime fortran fortran-package-manager fpm timing wallclock
Last synced: about 1 month ago
JSON representation
package for measuring cpu and wall clock execution time
- Host: GitHub
- URL: https://github.com/urbanjost/m_stopwatch
- Owner: urbanjost
- License: unlicense
- Created: 2021-11-21T04:57:14.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-17T06:49:16.000Z (almost 2 years ago)
- Last Synced: 2024-11-08T03:48:05.501Z (3 months ago)
- Topics: cputime, fortran, fortran-package-manager, fpm, timing, wallclock
- Language: Fortran
- Homepage:
- Size: 4.48 MB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# M_stopwatch.f90 and associated files
## Name
M_stopwatch - package for measuring cpu and wall clock execution time (LICENSE:PD) based on [StopWatch](https://math.nist.gov/StopWatch)
## Description
M_StopWatch is a Fortran 90 module for measuring execution time of
program segments. M_StopWatch is designed to be a portable, easy-to-use
means of measuring execution time. It supports wall clock, CPU time,
and a breakdown of the CPU clock into user and system times. It returns
all times in seconds. It provides a simple means of determining which
clocks are available, and the precision of those clocks.
M_StopWatch is used by instrumenting your code with subroutine calls
that mimic the operation of a stop watch. The primary routines are
start_watch, stop_watch, reset_watch, read_watch, and print_watch.
M_StopWatch supports multiple watches, and provides the concept of watch
groups to allow functions to operate on multiple watches simultaneously.
## Download and Build with Make(1) 
Just download the github repository, enter the src/ directory and run make:
```text
git clone https://github.com/urbanjost/M_stopwatch.git
cd M_stopwatch/src
# change Makefile if not using one of the listed compilers
# for gfortran
make clean
make F90=gfortran gfortran
# for ifort
make clean
make F90=ifort ifort
# for nvfortran
make clean
make F90=nvfortran nvfortran
# optionally
make test # run the unit tests
make run # run all the demo programs from the man-pages
make help # see other developer options
```
This will compile the M_stopwatch(3f) module and optionally build
all the example programs from the document pages in the example/
sub-directory and run the unit tests.
## Download and Build with FPM(1) 
Alternatively, download the github repository and build it with
fpm ( as described at [Fortran Package Manager](https://github.com/fortran-lang/fpm) )
```bash
git clone https://github.com/urbanjost/M_stopwatch.git
cd M_stopwatch
fpm build
fpm test # run unit tests
```
or just list it as a dependency in your fpm.toml project file.
```toml
[dependencies]
M_stopwatch = { git = "https://github.com/urbanjost/M_stopwatch.git" ,tag="v1.0.1"}
```
Note that M_stopwatch.f90 is registered at the [fpm(1) registry](https://github.com/fortran-lang/fpm-registry)
## Documentation 
### User
[user guide](https://urbanjost.github.io/M_stopwatch/user_guide.html).
-  man-page archives for use on GNU/Linux, Unix and CygWin platforms:
+ [manpages.zip](https://urbanjost.github.io/M_stopwatch/manpages.zip)
+ [manpages.tgz](https://urbanjost.github.io/M_stopwatch/manpages.tgz)
- [CHANGELOG](docs/CHANGELOG.md) provides a history of significant changes
### Developer (__experimental__)
- The code was run through [ford(1)](https://politicalphysicist.github.io/ford-fortran-documentation.html)
to produce a [developers' document](https://urbanjost.github.io/M_stopwatch/fpm-ford/index.html).
- [github action status](docs/STATUS.md)
## Demo Programs
Each man-page includes a working example program. These and additional
examples are included in the [example/](example/) directory.