@grnsft/if NPM

Welcome to CarbonHack 24 from the Green Software Foundation.

From Monday, 18th March - Monday, 8th April 2024, participants will compete to showcase their best application of IF in measuring the environmental impacts of software.
Carbon Hack is a dynamic competition that combines healthy rivalry with collaborative innovation. Hackers will push the limits of the framework, uncover potential weaknesses, and create innovations to enhance the tool.
CarbonHack is open to all, including software practitioners and those with a passion for Green Software.
Find out more about CarbonHack 2024 on the CarbonHack website. Check out the FAQ on GitHub.
Registration opens 15th January!
PLEASE NOTE hackathon projects are not supposed to be raised as pull requests to this rpeository! Please keep your hackathon plugins in your own repositories and submit links instead of raising PRs!

Impact Framework

!IMPORTANT Incubation Project: This project is an incubation project being run inside the Green Software Foundation; as such, we DON’T recommend using it in any critical use case. Incubation projects are experimental, offer no support guarantee, have minimal governance and process, and may be retired at any moment. This project may one day Graduate, in which case this disclaimer will be removed.

Note We have recently refactored the IF codebase and introduced some changes affecting both users and developers. You can read our migration guide HERE to help you update to the latest version!

Impact Framework (IF) is an Incubation project from the Open Source Working Group in the Green Software Foundation.

Our documentation is online at if.greensoftware.foundation

IF is a framework to Model, Measure, siMulate and Monitor the environmental impacts of software

Modern applications are composed of many smaller pieces of software (components) running on many different environments, for example, private cloud, public cloud, bare-metal, virtualized, containerized, mobile, laptops, and desktops.

Every environment requires a different plugin of measurement, and there is no single solution you can use to calculate the environmental impacts for all components across all environments.

The friction to measuring software emissions isn't that we need to know how, it's that we run software on many things and each thing has several different ways to measure.

Read the specification and design docs to begin.

Get started

The first thing to understand is that IF is a framework for running plugins. This means that in order to do some calculations, you need to load some plugins from some external resource. We provide a standard library of plugins and a repository of community plugins to get you started.

Start by installing framework itself:

npm install -g "@grnsft/if"

Then installing some plugins:

npm install -g "@grnsft/if-plugins"

Then create a manifest file that describes your application (see our docs for a detailed explanation).

Then, run if using the following command:

ie --manifest <path-to-your-manifest-file>

You can also add an optional savepath for your output yaml (if you do not provide one, the output will be printed to the console):

ie --manifest <path-to-your-manifest-file> --output <your-savepath>

The ie CLI tool will configure and run the plugins defined in your input yaml (manifest) and return the results as an output yaml (output).

Documentation

Please read our documentation at if.greensoftware.foundation

Video walk-through

Watch this video to learn how to create and run a manifest.

Contributing

To contribute to IF, please fork this repository and raise a pull request from your fork.

You can check our issue board for issues tagged help-wanted. These are issues that are not currently, actively being worked on by the core team but are well-scoped enough for someone to pick up. We recommend commenting on the issue to start a chat with the core team, then start working on the issue when you have been assigned to it. This process helps to ensure your work is aligned with our roadmap and makes it much more likely that your changes will get merged compared to unsolicited PRs.

Please read the full contribution guidelines at if.greensoftware.foundation

The same guidelines also apply to if-docs, if-plugins and if-unofficial-plugins.