search

Green-Software-Foundation / carbon-aware-sdk

Carbon-Aware SDK
https://carbon-aware-sdk.greensoftware.foundation/
MIT License
485 stars 99 forks source link

Documentation: WattTime provides marginal while Electricity Map provides average signal #573

Open Ravichou opened 1 month ago

Ravichou commented 1 month ago

Contact Details

castellon.robin@gmail.com

Overview of Change

Hello,

The documentation of the Web API states that it provides "the marginal carbon intensity for a given location and time period".

However, looking at the implementation of the Electricity Map API, here , there, and there, it seems like the SDK retrieves the average signal from the Electricity Map, not the marginal one.

Furthermore this difference with the WattTime API could also be explicited in the selecting a datasource tutorial, as I believe this a significant feature difference between both APIs.

From the SCI standpoint, this is fine, as it accepts both marginal and average signals. However I think this should be explicited in the doc: remove the 'marginal' in the Web API doc, and explicit the different behavior in the data source doc.

Thanks and best regards, Robin

Code of Conduct

danuw commented 3 weeks ago

Thank you very much @Ravichou for noticing this. I have not yet looked at the details but the Electricity Map implementation came later so that part of the doc must only comply with the old stuff.

Are you able to provide a pull request matching your suggestions please? That would help speed up a fix.

Let me/us know. Thanks