Skip to content

Commit

Permalink
docs: Remove on emission factor sec in contributing
Browse files Browse the repository at this point in the history
* Update countryCode description in README

Signed-off-by: Mahendra Paipuri <[email protected]>
  • Loading branch information
mahendrapaipuri committed Feb 9, 2024
1 parent 43f5a12 commit af73cd8
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ JupyterLab v3.6.6
@mahendrapaipuri/jupyter-power-usage v0.1.0 enabled OK
```

## Estimating emission factor
<!-- ## Estimating emission factor
Currently only French real time emission factor is implemented in the extension to estimation eCO<sub>2</sub> emissions based on power usage. For the rest of the countries a constant emission factor that can be configurable is used.
Expand All @@ -99,7 +99,7 @@ In order to add support for other countries, users need to make changes in the f
- Add all the necessary logic to get the emission factor in g/kWh for the country in its namespace.
- Finally, modify `getEmissions` function in [emissionsHandler.ts](./src/emissionsHandler.ts) to get the emission factor of the country.
We need to add the country code in the enum section of `countryCode` object in [plugin.json](./schema/plugin.json). This enables users to use this country specific emission factor to estimate emissions.
We need to add the country code in the enum section of `countryCode` object in [plugin.json](./schema/plugin.json). This enables users to use this country specific emission factor to estimate emissions. -->

## pre-commit

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ The frontend extension settings can be accessed by `Settings -> Advanced Setting

- `Electricity Maps Access token`: An API access token for Electricity Maps (See [Server Config](#electricity-maps-api-token)).

- `Country code`: Currently only data for France is supported. The realtime emission factor from [RTE eCO<sub>2</sub> mix](https://www.rte-france.com/en/eco2mix/co2-emissions). We encourage users to add support for other countries. Please check [`CONTRIBUTING.md`](CONTRIBUTING.md) on how to do it. If your country is not available in the list, leave it blank.
- `Country code`: ISO 3166-1 alpha-2 country code. This will be used only when `Electricity Maps` emission factor source is used.

- `Refresh rate`: This defines how often the emission factor is updated in ms. For [RTE eCO<sub>2</sub> mix](https://www.rte-france.com/en/eco2mix/co2-emissions) data, it is updated every 30 min and has a rate limit of 50000 API requests per month.

Expand Down

0 comments on commit af73cd8

Please sign in to comment.