Skip to content

Commit d55a5c1

Browse files
authored
Merge pull request #799 from powerapi-ng/docs/update-readme-2026
docs(README): Refresh project overview and publication/citation sections
2 parents e9638b0 + 3ef9f96 commit d55a5c1

File tree

1 file changed

+7
-22
lines changed

1 file changed

+7
-22
lines changed

README.md

Lines changed: 7 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,29 @@
11
<img src="https://powerapi.org/assets/images/PowerAPI-logo.png" alt="PowerAPI logo" width="300px">
22

3-
[![License: BSD 3](https://img.shields.io/pypi/l/powerapi.svg)](https://opensource.org/licenses/BSD-3-Clause)
3+
[![License: BSD-3-Clause](https://img.shields.io/pypi/l/powerapi.svg)](https://opensource.org/licenses/BSD-3-Clause)
44
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/powerapi-ng/powerapi/build.yml)](https://github.com/powerapi-ng/powerapi/actions/workflows/build.yml)
55
[![PyPI](https://img.shields.io/pypi/v/powerapi)](https://pypi.org/project/powerapi/)
66
[![Codecov](https://codecov.io/gh/powerapi-ng/powerapi/branch/master/graph/badge.svg)](https://codecov.io/gh/powerapi-ng/powerapi)
7-
[![Zenodo](https://zenodo.org/badge/DOI/10.5281/zenodo.11453194.svg)](https://doi.org/10.5281/zenodo.11453194)
87
[![JOSS paper](https://joss.theoj.org/papers/ff5876ca096c62cb6d243e56b5676c4e/status.svg)](https://joss.theoj.org/papers/ff5876ca096c62cb6d243e56b5676c4e)
98

109
PowerAPI is a middleware toolkit for building software-defined power meters.
1110
Software-defined power meters are configurable software libraries that can estimate the power consumption of software in real-time.
1211
PowerAPI supports the acquisition of raw metrics from a wide diversity of sensors (*eg.*, physical meters, processor interfaces, hardware counters, OS counters) and the delivery of power consumptions via different channels (including file system, network, web, graphical).
1312
As a middleware toolkit, PowerAPI offers the capability of assembling power meters *«à la carte»* to accommodate user requirements.
1413

15-
# About
16-
14+
## About
1715
PowerAPI is an open-source project developed by the [Spirals project-team](https://team.inria.fr/spirals), a joint research group between the [University of Lille](https://www.univ-lille.fr) and [Inria](https://www.inria.fr).
1816

19-
The documentation of the project is available [here](http://powerapi.org).
17+
More information about the project can be found on the [PowerAPI website](https://powerapi.org).
2018

2119
## Mailing list
2220
You can follow the latest news and asks questions by subscribing to our <a href="mailto:sympa@inria.fr?subject=subscribe powerapi">mailing list</a>.
2321

2422
## Contributing
25-
If you would like to contribute code you can do so through GitHub by forking the repository and sending a pull request.
26-
27-
When submitting code, please make every effort to [follow existing conventions and style](CONTRIBUTING.md) in order to keep the code as readable as possible.
23+
To learn more about making a contribution to PowerAPI, please see our [Contributing guide](CONTRIBUTING.md).
2824

2925
## Publications
26+
- **[xPUE: Extending Power Usage Effectiveness Metrics for Cloud Infrastructures](https://inria.hal.science/hal-04980997v1)**: G. Fieni, R. Rouvoy, L. Seinturier. _IEEE Transactions on Sustainable Computing_ (TSUSC). 2025.
3027
- **[PowerAPI: A Python framework for building software-defined power meters](https://joss.theoj.org/papers/10.21105/joss.06670)**: G. Fieni, D. Romero Acero, P. Rust, R. Rouvoy. _Journal of Open Source Software_ (JOSS). The Open Journal, June 2024.
3128
- **[Evaluating the Impact of Java Virtual Machines on Energy Consumption](https://hal.inria.fr/hal-03275286v1)**: Z. Ournani, MC. Belgaid, R. Rouvoy, P. Rust, J. Penhoat. _15th ACM/IEEE International Symposium on Empirical Software Engineering and Measurement_ (ESEM). October 2021, Bari, Italy.
3229
- **[SelfWatts: On-the-fly Selection of Performance Events to Optimize Software-defined Power Meters](https://hal.inria.fr/hal-03173410v1)**: G. Fieni, R. Rouvoy, L. Seiturier. _20th IEEE/ACM International Symposium on Cluster, Cloud and Internet Computing_ (CCGRID 2021). May 2021, Melbourne, Australia.
@@ -44,20 +41,8 @@ When submitting code, please make every effort to [follow existing conventions a
4441
- **[Runtime Monitoring of Software Energy Hotspots](https://hal.inria.fr/hal-00715331)**: A. Noureddine, A. Bourdon, R. Rouvoy, L. Seinturier. _International Conference on Automated Software Engineering_ (ASE), September 2012, Essen, Germany. pp.160-169.
4542
- **[A Preliminary Study of the Impact of Software Engineering on GreenIT](https://hal.inria.fr/hal-00681560)**: A. Noureddine, A. Bourdon, R. Rouvoy, L. Seinturier. _International Workshop on Green and Sustainable Software_ (GREENS), June 2012, Zurich, Switzerland. pp.21-27.
4643

47-
## Use Cases
48-
PowerAPI is used in a variety of projects to address key challenges of GreenIT:
49-
* [SmartWatts](https://github.com/powerapi-ng/smartwatts-formula) is a self-adaptive power meter that can estimate the energy consumption of software containers in real-time.
50-
* [GenPack](https://hal.inria.fr/hal-01403486) provides a container scheduling strategy to minimize the energy footprint of cloud infrastructures.
51-
* [VirtualWatts](https://github.com/powerapi-ng/virtualwatts-formula) provides process-level power estimation of applications running in virtual machines.
52-
* [Web Energy Archive](http://webenergyarchive.com) ranks popular websites based on the energy footpring they imposes to browsers.
53-
* [Greenspector](https://greenspector.com) optimises the power consumption of software by identifying potential energy leaks in the source code.
54-
55-
## Research Projects
56-
57-
Currently, PowerAPI is used in two research projects:
58-
59-
- [Distiller ANR Project](https://www.davidson.fr/blog/comment-reduire-limpact-environnemental-des-applications-cloud-davidson-consulting-inria-ovhcloud-orange-sassocient-pour-le-programme-de-recherche-distiller) that searches to reduce energy consumption of Cloud applications.
60-
- [Défi Pulse](https://www.inria.fr/fr/pulse-defi-qarnot-computing-ademe-calcul-intensif-hpc-environnement) studies how to valorize emissions from High Performance Computing (HPC) using as use case [Qarnot Computing's](https://qarnot.com/en) offers.
44+
## Citation
45+
If you use PowerAPI in a scientific publication, we would appreciate citations to this paper: https://doi.org/10.21105/joss.06670
6146

6247
## License
6348
PowerAPI is licensed under the BSD-3-Clause License. See the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)