Green-Software-Foundation / if-unofficial-plugins

Impact Framework unofficial models maintained by the community
MIT License
17 stars 19 forks source link

feat(lib): Add electricitymaps model #61

Closed unitrium closed 5 months ago

unitrium commented 6 months ago

Types of changes

A description of the changes proposed in the Pull Request

Add an integration for electricitymaps as an unofficial if model. The model gets the carbon intensity of the grid in a specific location and computes either the carbon intensity or the total emissions for an event in this location connected to the grid.

This integration requires an electricity map token, instructions on how to get one have been added in the readme.

jmcook1186 commented 6 months ago

Hi @unitrium thanks a lot for this PR, it looks very useful! We will be happy to give it a review if it is helpful, but would prefer not to merge it into this repository. The reason for this is that we eventually want to deprecate and remove this entire repository and instead encourage builders to maintain plugins in their own repos, so we can build up an ecosystem of plugins that's not limited by the core team's ability to maintain them. @jawache

This has also made me realise we need much clearer documentation around this - coming very soon.

unitrium commented 5 months ago

Hi @jmcook1186 thanks for getting back to me. I would indeed appreciate a review for this. We will see later how we can host it ourselves in our repository.

jmcook1186 commented 5 months ago

Hi - sorry for the delayed response on this - it looks like your plugin is designed for the old IF. There are some tweaks required to make it intergate with the refactored version that we released a few weeks ago. You can check the migration guide in the if repo here: https://github.com/Green-Software-Foundation/if/blob/main/Refactor-migration-guide.md

jmcook1186 commented 5 months ago

Closing as superseded by hackathon submission