pyEnergiBridge

KO | EN

gitlite — search

#react #llm #go #golang #android #deep-learning #docker #nodejs #awesome #cli #security #ios #openai #open-source

(★ 9)

Python wrapper to collect software energy consumption data using EnergiBridge

pyEnergiBridge Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# pyEnergiBridge

pyEnergiBridge is a Python wrapper that enables the collection of software energy consumption data using EnergiBridge.

## Installation

You can install pyEnergiBridge via pip. First, clone the repository:

```bash
git clone https://github.com/luiscruz/pyEnergiBridge.git
cd pyEnergiBridge
```

Then, install the package using pip:
```bash
pip install .
```

## Configuration

By default, pyEnergiBridge looks for the `EnergiBridge` binary in a predefined path. You can customize the path to the EnergiBridge binary using configuration files. The configuration files can be placed in the user's home directory or in the project directory.

### 1. Home Directory Configuration:
Create a file named `.pyenergibridge_config.json` in your home directory:

```json
{
    "binary_path": "/custom/path/to/EnergiBridge/binary/executable
}
```

### 2. Project Directory Configuration:
Create a file named `pyenergibridge_config.json` in your project directory:

```json
{
    "binary_path": "/custom/path/to/EnergiBridge/binary/executable"
}
```

pyEnergiBridge will first look for the configuration file in the project directory, and if it is not found, it will look for the configuration file in the home directory. If no configuration files are found, it will check if `EnergiBridge` is available in the system's PATH. If none of these methods provide a valid path, it will raise a `FileNotFoundError`.

## Usage

### Basic Usage
To collect energy consumption data within your Python code, follow these steps:

```python
import time
from pyEnergiBridge.api import EnergiBridgeRunner

runner = EnergiBridgeRunner()
runner.start(results_file="results.csv")

# Perform some task
time.sleep(2)

# Stop the data collection and retrieve results
energy, duration = runner.stop()
print(f"Energy consumption (J): {energy}; Execution time (s): {duration}")
```

> If your task may raise an exception, ensure it is wrapped in a `try/finally` block, similar to how it's handled in the `with_energibridge` wrapper.

```python
try:
  your_task()
finally:
  energy, duration = runner.stop()
```

### Using Decorator
You can also use a decorator to simplify the process:

```python
import time
from pyEnergiBridge.api import with_energibridge

@with_energibridge(results_file="results.csv")
def my_task():
    # Simulate a task running for a short period of time
    time.sleep(2)
    print("Task completed.")

# Execute the task
my_task()
```
Make sure to check the "results.csv" file to confirm that the energy consumption data has been stored successfully.

### IPython Magic Commands

You can use IPython magic commands to measure energy consumption and execution time for code cells and lines directly within Jupyter notebooks.

#### Cell Magic

Use the `%%measure_energy_time_cell` magic command to measure the energy consumption and execution time of an entire cell:

```python
%%measure_energy_time_cell
import time
time.sleep(2)
print("Task completed.")
```
#### Line Magic

Use the `%measure_energy_time_line` magic command to measure the energy consumption and execution time of a single line of code:

```python
%measure_energy_time_line time.sleep(2)
print("Task completed.")
```

### Usage With Docker

Due to different process management in Docker containers, you need to set the `is_containerized` flag on instantiation of the `EnergiBridgeRunner`:

```python
from pyEnergiBridge.api import EnergiBridgeRunner

runner = EnergiBridgeRunner(is_containerized=True)
```

> Note: this only works for Linux Docker containers and will fail on Windows.

pyEnergiBridge

pyEnergiBridge Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

pyEnergiBridge

pyEnergiBridge Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README