Skip to content

StephanieHhnbrg/manifest-wizard

Repository files navigation

Manifest Wizard

MIT License

Introduction

This tool is a contribution to the annual hackathon from the Green Software Foundation Carbon Hack'24, which is focussing on the Impact Framework (IF)

IF is a framework to meassure the environmental impact of software applications. By setting up a pipeline of plugins and adding time-series observations, a variety of environmental meassurements can be computed, like carbon emissions or energy consumption. The core component of the IF is the manifest, which is configuring the pipeline of plugins and defining the observable timeseries data in a yaml file.

Manifest Wizard is a tool to support the generation of such a manifest file and provides the following features:
🔸 manifest generation
🔸 visualization of the configured pipeline
🔸 upload and download of input data
🔸 visualization of output data
🔸 custom creation of charts

Installation

The tool is deployed as a Github Page.

But in case you would like to run the project locally, follow these steps:

  • Install dependencies: npm install
  • Start project: npm run start

Basic Tutorial

  1. Configure the pipeline
    Tutorial - Step1

  2. Upload your observations
    Tutorial - Step2

  3. Download the manifest file

  4. Run IF in your terminal

  • npm install -g @grnsft/if
  • npm install -g @grnsft/if-plugins
  • npm install -g @grnsft/if-unofficial-plugins
  • ie --manifest <path to your manifest file> --output <output-path>
  1. Visualize the output data
    Tutorial - Step5