Skip to content

Commit

Permalink
Merge pull request #54 from Green-Software-Foundation/plugins-update
Browse files Browse the repository at this point in the history
Update cloud-metadata, add  divide and regex plugins links
  • Loading branch information
jmcook1186 authored Mar 11, 2024
2 parents adf19fe + 261d961 commit 6cfaf74
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/developers/how-to-write-unit-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ Please use `jest --coverage` to see a coverage report for your plugin - your uni
| All files | 100 | 100 | 100 | 100 |
| lib | 100 | 100 | 100 | 100 |
| index.ts | 100 | 100 | 100 | 100 |
| lib/cloud-instance-metadata | 100 | 100 | 100 | 100 |
| lib/cloud-metadata | 100 | 100 | 100 | 100 |
| index.ts | 100 | 100 | 100 | 100 |
| lib/e-mem | 100 | 100 | 100 | 100 |
| index.ts | 100 | 100 | 100 | 100 |
Expand Down
7 changes: 4 additions & 3 deletions docs/reference/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Documentation for the specific individual plugins are available in the plugin RE
### `if-plugins`


* [Cloud instance metadata](https://github.com/Green-Software-Foundation/if-plugins/blob/main/src/lib/cloud-instance-metadata/README.md): Looks up detailed metadata about a given cloud instance type, including the physical processor being used.
* [Cloud metadata](https://github.com/Green-Software-Foundation/if-plugins/blob/main/src/lib/cloud-metadata/README.md): Looks up detailed metadata about a given cloud instance type and region, including the physical processor being used.
* [E-MEM](https://github.com/Green-Software-Foundation/if-plugins/blob/main/src/lib/e-mem/README.md): Calculate the energy expended due to memroy usage, by multiplying the energy used in GB by a coefficient.
* [SCI-E](https://github.com/Green-Software-Foundation/if-plugins/blob/main/src/lib/sci-e/README.md): Calculates the sum of all energy components.
* [SCI-M](https://github.com/Green-Software-Foundation/if-plugins/blob/main/src/lib/sci-m/README.md) - Calculates the embodied carbon for a component.
Expand All @@ -26,9 +26,10 @@ Documentation for the specific individual plugins are available in the plugin RE
* [Multiply](https://github.com/Green-Software-Foundation/if-plugins/tree/main/src/lib/multiply): a generic arithmetic plugin that allows you to multiply any set of input parameters.
* [Coefficient](https://github.com/Green-Software-Foundation/if-plugins/tree/main/src/lib/coefficient): a generic arithmetic plugin that allows you to multiply any input value by a coefficient.
* [E-NET](https://github.com/Green-Software-Foundation/if-plugins/tree/main/src/lib/e-net): simply multiplies the amount of data transferred (GB) by a coefficient (kWh/GB) to yield network/energy.
* [Mock Observations Model](https://github.com/Green-Software-Foundation/if-plugins/tree/main/src/lib/mock-observations): A model for mocking observations (inputs) for testing and demo purposes.
* [Mock Observations](https://github.com/Green-Software-Foundation/if-plugins/tree/main/src/lib/mock-observations): A plugin for mocking observations (inputs) for testing and demo purposes.
* [CSV-Export](https://github.com/Green-Software-Foundation/if-plugins/tree/main/src/lib/csv-export): a generic CSV exporter plugin.

* [Divide](https://github.com/Green-Software-Foundation/if-plugins/tree/main/src/lib/divide): A generic plugin for doing arithmetic division of two values.
* [Regex](https://github.com/Green-Software-Foundation/if-plugins/tree/main/src/lib/regex): A generic plugin to match part of one string and extract it into another.


### `if-unofficial-plugins`
Expand Down
6 changes: 3 additions & 3 deletions docs/users/how-to-import-plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ tags:
initialize:
plugins:
azure-importer:
method: AzureImporterModel
method: AzureImporter
path: "@grnsft/if-unofficial-plugins"
cloud-instance-metadata:
method: CloudInstanceMetadataModel
cloud-metadata:
method: CloudMetadata
path: "@grnsft/if-plugins"
```
Expand Down

0 comments on commit 6cfaf74

Please sign in to comment.