we3lab / we3lab/eeco

ENH: extend support for emissions calculator to full year

Open
#32 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement needs triage
Dominant language
Python
Stars
11
Forks
4
Avg merge
5d 4h
Merged PRs (30d)
1

Description

Use Case

Currently the emissions calculator in emissions.py accounts for rolling over between months, but not years. In theory, it should be simple to extend this logic to any contiguous time period so analysis that spans years would be supported.

Solution

Rename current get_carbon_intensity to get_monthly_carbon_intensity and write a new wrapper called get_carbon_intensity that can process any arbitrary time period.

Alternatives

The alternative is what we are already doing, a script that loops through months and processes them separately.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in emissions.py by reading the current get_carbon_intensity implementation and how it handles month rollover. Rename that behavior to get_monthly_carbon_intensity, then define the new get_carbon_intensity wrapper for contiguous periods spanning multiple years. Done means existing monthly behavior remains available and full-year or cross-year analysis is supported.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.