|
2 | 2 |
|
3 | 3 | A Framework to **M**odel, **M**easure, si**M**ulate and **M**onitor the environmental impacts of software.
|
4 | 4 |
|
5 |
| -> Key |
6 |
| -> - ✅ Done |
7 |
| -> - ✍🏽 Draft |
8 |
| -> - 👷🏽♂️ Todo |
9 |
| -> - 🔥 Priority |
10 |
| -> - 🦖 Outdated |
11 |
| -## Concepts |
12 |
| -- ✅ [Background](Background.md) |
13 |
| -- ✅ [Motivation](Motivation.md) |
14 |
| -- 👷🏽♂️ [4Ms](4Ms) 🔥🔥 |
15 |
| -- 👷🏽♂️ [Measurement for Reporting vs Action](Measurement%20for%20Reporting%20vs%20Action) 🔥🔥 |
| 5 | +Impact Framework is a command line tool that runs model plugins in a pipeline, allowing a flexible, configurable way to calculate the energy and carbon impacts of your software. |
16 | 6 |
|
17 |
| -## Non Functional Requirements |
18 |
| -- 👷🏽♂️ [5 Mins to Wow](5%20Mins%20to%20Wow) 🔥🔥 |
19 |
| - |
20 |
| -## Functional Requirements |
21 |
| -- 👷🏽♂️ [User Stories](User%20Stories) 🔥 |
22 |
| - |
23 |
| -## Design Docs |
24 |
| -- ✅ [Terminology](../Terminology.md) |
25 |
| -- ✅ [Graph](graph.md) |
26 |
| - - ✅ [input](input.md) |
27 |
| - - ✅ [Durations](durations.md) |
28 |
| - - ✅ [Granularity](granularity.md) |
29 |
| -- ✅ [Impl (Impact YAML)](impl.md) |
30 |
| -- 👷🏽♂️[Impact Model](model.md) |
31 |
| -- ✅ [Impact Model Plugin](model-plugin.md) |
32 |
| -- ✅ [Model Plugin Configuration](model-plugin-configuration.md) |
33 |
| -- ✅ [Computation Pipeline](computation-pipeline.md) |
34 |
| - |
35 |
| -## Use Cases |
36 |
| - |
37 |
| -- 👷🏽♂️ [Open Source Software](Open%20Source%20Software) 🔥 |
38 |
| -- 👷🏽♂️ [Calculating an SCI Score](Calculating%20an%20SCI%20Score) |
39 |
| -- 👷🏽♂️ [Higher Order Impact Models](Higher%20Order%20Impact%20Models.md) |
| 7 | +To learn more about the command line tool, see [Impact Engine](./impact-engine.md). |
| 8 | +To learn about model plugins, see [model plugins](./model-plugin.md) |
0 commit comments