Skip to content

Commit

Permalink
Merge pull request #13 from Green-Software-Foundation/add-hackathon-c…
Browse files Browse the repository at this point in the history
…allout

Add hackathon callout
  • Loading branch information
jmcook1186 authored Dec 19, 2023
2 parents e8b9087 + 4333340 commit 8e26d7f
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 1 deletion.
22 changes: 21 additions & 1 deletion docs/01-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,26 @@ sidebar_position: 1

# Overview

## Hackathon!

![](imgs/../../src/imgs/hack-banner.png)

----------------------------
From Monday, February 26 - Friday, March 15, 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](https://grnsft.org/hack/github)

**Registration opens 15th January!**

----------------------------

<br />

## Impact Framework

Impact Framework (IF) aims to make the environmental impacts of software easier to calculate **and** share.

IF allows you to calculate the environmental impacts, such as carbon, of your software applications without writing any code. All you have to do is write a simple **manifest file**, known as an `impl` and IF handles the rest.
Expand All @@ -27,7 +47,7 @@ Only through a granular analysis of the impacts of your software system can inve

The **IF source code** can be found in the [IF Github repository](https://github.com/Green-Software-Foundation/if). The code there covers the framework, which includes all the infrastructure for reading and writing input and output yamls, invoking models, running the command line tool and associated helper functions. However, it does not include the actual models themselves. Part of the IF design philosophy is that all models should be plugins, so that the IF is as composable and configurable as possible. Therefore, to use IF, you have to either create your own models or find some prebuilt ones and install them yourself. This also implies that you take responsibility for the models you choose to install.

We do provide a **standard library of models** built and maintained by the IF core team. These cna be found in the [`if-models` Github repository](https://github.com/Green-Software-Foundation/if-models). You can install these into `if` by running `yarn install https://github.com/Green-Software-Foundation/if-models` from the `if` project directory.
We do provide a **standard library of models** built and maintained by the IF core team. These can be found in the [`if-models` Github repository](https://github.com/Green-Software-Foundation/if-models). You can install these into `if` by running `yarn install https://github.com/Green-Software-Foundation/if-models` from the `if` project directory.

There is also a second repository for **models we expect community members to maintain**. These can be found in the [`if-unofficial-models` Github repository](https://github.com/Green-Software-Foundation/if-unofficial-models). You can install these into `if` by running `yarn install https://github.com/Green-Software-Foundation/if-unofficial-models` from the `if` project directory.

Expand Down
Binary file added src/imgs/hack-banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions src/theme/Navbar/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ export default function NavbarWrapper(props) {
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.
<br />
<br />
We are running a Hackathon! CarbonHack is open to all, including software practitioners and those with a passion for Green Software. Find out more on the <a href='https://grnsft.org/hack/github'>CarbonHack website</a>
</div>
<Navbar {...props} />
</>
Expand Down

0 comments on commit 8e26d7f

Please sign in to comment.