---
title: BoAmps Report Creation
emoji: 🌿
colorFrom: red
colorTo: green
sdk: gradio
sdk_version: 5.15.0
app_file: app.py
pinned: false
license: apache-2.0
short_description: Create a report in BoAmps format
---

# BoAmps Report Creation Tool 🌿

This tool is part of the initiative [BoAmps](https://github.com/Boavizta/BoAmps). 
The purpose of the BoAmps project is to build a large, open, database of energy consumption of IT / AI tasks depending on data nature, algorithms, hardware, etc., in order to improve energy efficiency approaches based on empiric knowledge.

This space was initiated by a group of students from Sud Telecom Paris, many thanks to [Hicham FILALI](https://huggingface.co/FILALIHicham) for his work.

## 🚀 Quick Start

### Prerequisites
- **Python** >= 3.12


### Installation Steps

1. **Clone the repository**

2. **Create and activate virtual environment (not mandatory)**
   ```bash
   # Windows
   python -m venv .venv
   .\.venv\Scripts\activate
   
   # Linux/MacOS
   python -m venv .venv
   source .venv/bin/activate
   ```

3. **Install dependencies**
   ```bash
   pip install pipenv
   pipenv install --dev
   ```

4. **Launch the application**
   ```bash
   python ./app.py
   ```

5. **Access the application**
   - Open your browser and go to `http://localhost:7860`
   - The Gradio interface will be available for creating BoAmps reports

## 🏗️ Architecture Overview

### Core Components

1. **`app.py`** - Main application file
   - Initializes the Gradio interface
   - Orchestrates all UI components
   - Handles application routing and main logic

2. **Services Layer (`src/services/`)**
   - **`json_generator.py`**: Generates BoAmps-compliant JSON reports
   - **`report_builder.py`**: Constructs structured report data
   - **`form_parser.py`**: Processes and validates form inputs
   - **`dataset_upload.py`**: Manages Hugging Face dataset integration
   - **`util.py`**: Common utility functions

3. **UI Layer (`src/ui/`)**
   - **`form_components.py`**: Gradio interface components for different report sections

4. **Assets & Validation (`assets/`)**
   - **`validation.py`**: BoAmps schema validation logic
   - **`app.css`**: Application styling

### Data Flow

```
User Input (Gradio Form) 
    ↓ 
Form Parser & Validation 
    ↓ 
JSON Generator 
    ↓ 
Report Builder 
    ↓ 
BoAmps Schema Validation 
    ↓ 
JSON Report Output
```

## 🤝 Contributing

Contributions are welcome! Please:

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Submit a pull request

## 📄 License

This project is licensed under the Apache 2.0 License - see the license information in the repository header.

## 🙏 Acknowledgments

This space was initiated by a group of students from Sud Telecom Paris, many thanks to [Hicham FILALI](https://huggingface.co/FILALIHicham) for his work.

For more information about the BoAmps initiative, visit the [official repository](https://github.com/Boavizta/BoAmps).