Skip to content

Commit

Permalink
docs: Create CITATION.cff and citation section in README
Browse files Browse the repository at this point in the history
  • Loading branch information
JuanPedroGHM authored Aug 24, 2023
1 parent 320cbe0 commit 910228f
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 0 deletions.
29 changes: 29 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
cff-version: 1.2.0
message: "If you use this software, please cite the paper."
preferred-citation:
type: conference-paper
authors:
- given-names: "Juan Pedro"
family-names: "Gutiérrez Hermosillo Muriedas"
email: "[email protected]"
affiliation: "Karlsruhe Institute für Technologie"
orcid: 'https://orcid.org/0000-0001-8439-7145'
- given-names: "Katharina"
family-names: "Flügel"
- given-names: "Charlotte"
family-names: "Debus"
- given-names: "Holger"
family-names: "Obermaier"
- given-names: "Achim"
family-names: "Streit"
- given-names: "Markus"
family-names: "Götz"
title: "perun: Benchmarking Energy Consumption of High-Performance Computing Applications"
year: 2023
collection-title: "Euro-Par 2023: Parallel Processing"
collection-doi: "10.1007/978-3-031-39698-4"
doi: "10.1007/978-3-031-39698-4_2"
conference:
name: "29th International European Conference on Parallel and Distributed Computing"
date-start: 2023-08-28
date-end: 2017-09-01
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,3 +113,34 @@ mpirun -n 8 perun monitor path/to/your/script.py
## Docs

To get more information, check out our [docs page](https://perun.readthedocs.io/en/latest/).

## Citing perun

If you found perun usefull, please consider citing the conference paper:

* Gutiérrez Hermosillo Muriedas, J.P., Flügel, K., Debus, C., Obermaier, H., Streit, A., Götz, M.: perun: Benchmarking Energy Consumption of High-Performance Computing Applications. In: Cano, J., Dikaiakos, M.D., Papadopoulos, G.A., Pericàs, M., and Sakellariou, R. (eds.) Euro-Par 2023: Parallel Processing. pp. 17–31. Springer Nature Switzerland, Cham (2023). https://doi.org/10.1007/978-3-031-39698-4_2.


```bibtex
@InProceedings{10.1007/978-3-031-39698-4_2,
author="Guti{\'e}rrez Hermosillo Muriedas, Juan Pedro
and Fl{\"u}gel, Katharina
and Debus, Charlotte
and Obermaier, Holger
and Streit, Achim
and G{\"o}tz, Markus",
editor="Cano, Jos{\'e}
and Dikaiakos, Marios D.
and Papadopoulos, George A.
and Peric{\`a}s, Miquel
and Sakellariou, Rizos",
title="perun: Benchmarking Energy Consumption of High-Performance Computing Applications",
booktitle="Euro-Par 2023: Parallel Processing",
year="2023",
publisher="Springer Nature Switzerland",
address="Cham",
pages="17--31",
abstract="Looking closely at the Top500 list of high-performance computers (HPC) in the world, it becomes clear that computing power is not the only number that has been growing in the last three decades. The amount of power required to operate such massive computing machines has been steadily increasing, earning HPC users a higher than usual carbon footprint. While the problem is well known in academia, the exact energy requirements of hardware, software and how to optimize it are hard to quantify. To tackle this issue, we need tools to understand the software and its relationship with power consumption in today's high performance computers. With that in mind, we present perun, a Python package and command line interface to measure energy consumption based on hardware performance counters and selected physical measurement sensors. This enables accurate energy measurements on various scales of computing, from a single laptop to an MPI-distributed HPC application. We include an analysis of the discrepancies between these sensor readings and hardware performance counters, with particular focus on the power draw of the usually overlooked non-compute components such as memory. One of our major insights is their significant share of the total energy consumption. We have equally analyzed the runtime and energy overhead perun generates when monitoring common HPC applications, and found it to be minimal. Finally, an analysis on the accuracy of different measuring methodologies when applied at large scales is presented.",
isbn="978-3-031-39698-4"
}
```

0 comments on commit 910228f

Please sign in to comment.