PolicyEngine / PolicyEngine/policyengine-uk

Document domestic/foreign consumption/production handling

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

Nobody has claimed this yet.

Dominant language
Python
Stars
50
Forks
33
Avg merge
20h 58m
Merged PRs (30d)
14

Description

Objective

Documentation for how our simulation handles:

  • Carbon consumed in the UK
  • Carbon produced in the UK
  • Carbon consumed outside the UK
  • Carbon produced outside the UK

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

The issue names four domestic and foreign consumption/production cases but does not identify documentation files or tests. Start by locating the repository’s existing simulation documentation and the code or model entry points that handle these cases. Done means documenting how all four cases are handled, with clear UK-versus-outside-UK distinctions.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.