jouleit

A repository of scripts that can be used to monitor energy consumption.

https://github.com/powerapi-ng/jouleit

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    3 of 5 committers (60.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (8.5%) to scientific vocabulary

Keywords

bash energy energy-consumption energy-scripts intel-rapl rapl
Last synced: 6 months ago · JSON representation ·

Repository

A repository of scripts that can be used to monitor energy consumption.

Basic Info
  • Host: GitHub
  • Owner: powerapi-ng
  • Language: Shell
  • Default Branch: master
  • Homepage:
  • Size: 157 KB
Statistics
  • Stars: 16
  • Watchers: 7
  • Forks: 5
  • Open Issues: 0
  • Releases: 0
Topics
bash energy energy-consumption energy-scripts intel-rapl rapl
Created almost 6 years ago · Last pushed 12 months ago
Metadata Files
Readme Citation

README.md

jouleit

A repository of scripts that can be used to monitor energy consumption for any program.

Requirements

  • Linux: Right now jouleit uses the Intel "Running Average Power Limit" (RAPL) technology that estimates power consumption of the CPU, ram and integrated GPU. This technology is available on Intel CPU since the Sandy Bridge generation(2010).

How to use

sudo ./jouleit.sh cmd

jouleit offers a set of options to help benchmarking and testing programs. The avialable options are

Flags and options

| Flag | Description | Default value | | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-----------------------: | | -g | print the details of all sockets instead of the aggregation | False | | -b | print the results in the format of KEY1:VALUE1;KEY2:VALUE2.. | False | | -l | list all the available domains (CPU, DRAM, etc.) and print them in the form of a header of CSV | | | -c | print only the values in CSV format (value1;value2;value3). We recommend using this after running *jouleit** with the -l flag to see the order of the measured values | false | | -s s0,s1,.. | measure only the energy of the component in the sockets s1,s2... | all the available sockets | | -o ofilename | redirect the output and the log of the executed program to the file ofilename | | | -n N | run the program N times and record the measured values in jfilename file | | | -j jfilename | redirect the csv formatted output of repeated runs to file jfilename file | date##########.csv | | -h | display the help message | |

Examples

we want to measure a Python script called work.py

instead of running it like this

python work.py 

alone

we run it with jouleit like this

  sudo ./jouleit.sh python work.py 

the default option if we want to aggregate the results we can use the flag -g

sudo ./jouleit.sh -g python work.py 

aggregated version

Owner

  • Name: PowerAPI
  • Login: powerapi-ng
  • Kind: organization
  • Email: contact@powerapi.org
  • Location: Lille, France

Software-Defined Power Meters

Citation (CITATION.cff)

cff-version: 1.2.0
title: "Jouleit : a tool that can be used to monitor energy consumption for any linux program"
message: Make your python code green again
type: software
date-released: 2020-05-07
authors:
  - given-names: Mohammed chakib
    family-names: Belgaid
    email: chakib.belgaid@gmail.com
    orcid: 'https://orcid.org/0000-0002-5264-7426'
    affiliation: Inria university of Lille
  - given-names: Romain
    family-names: Rouvoy
    email: romain.rouvoy@inria.fr
    affiliation: inria university of lille
    orcid: 'https://orcid.org/0000-0003-1771-8791'
  - orcid: 'https://orcid.org/0000-0003-0006-6088'
    affiliation: 'Inria  university of lille '
    email: lionel.seinturier@univ-lille.fr
    family-names: Seinturier
    given-names: Lionel
identifiers:
  - type: url
    value: https://github.com/powerapi-ng/jouleit/
repository-code: 'https://github.com/powerapi-ng/jouleit/'
abstract: >-
  A tool that can be used to monitor energy consumption for any program in linux based systems

GitHub Events

Total
  • Watch event: 2
  • Issue comment event: 2
  • Push event: 1
  • Pull request event: 2
Last Year
  • Watch event: 2
  • Issue comment event: 2
  • Push event: 1
  • Pull request event: 2

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 43
  • Total Committers: 5
  • Avg Commits per committer: 8.6
  • Development Distribution Score (DDS): 0.419
Past Year
  • Commits: 1
  • Committers: 1
  • Avg Commits per committer: 1.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
belgaid mohammed chakib c****d@g****m 25
Naif Mehanna n****a@i****r 8
Mohammed-Chakib Belgaid m****d@u****r 8
Romain Rouvoy r****y@u****r 1
Taylor Paul t****1@g****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 9 months ago

All Time
  • Total issues: 3
  • Total pull requests: 3
  • Average time to close issues: 3 months
  • Average time to close pull requests: 5 months
  • Total issue authors: 3
  • Total pull request authors: 3
  • Average comments per issue: 1.0
  • Average comments per pull request: 0.67
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: 1 day
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 2.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • chakib-belgaid (1)
  • lmedini (1)
  • wanecek (1)
Pull Request Authors
  • taylorpaul (2)
  • wanecek (1)
  • chakib-belgaid (1)
Top Labels
Issue Labels
enhancement (1)
Pull Request Labels
enhancement (1)