Home

Building Emissions

This project analyses various datasets to produce estimates of the carbon emissions from the buildings sector. You may be interested to update some of the datasets or methods, or maybe just want to compare results. Results are conveniently published on Climate Trace's platform, if you only want to do the latter.

The repository and this wiki are organised based on the activity that causes emissions, for example heating.

Pages

• Heating

Contributing

See the main readme file in the repository for getting the project up and running. This project uses a containerised environment as well as a virtual environment for python packages -- the main readme file also outlines the impacts of this set-up on the workflow.

Branching strategy

Building emissions:

• update/x - update architecture, code refactoring, etc.
• feature/x - implements a feature
• fix/x - fixes something
• document/x - updates documentation, README, etc.
• test/x - adds a test case

Building emissions wiki:

• Only master branch is rendered on github wiki

Tip: For rendering the wiki files locally, try the python package grip.

Attribute naming conventions

To keep things clean, attribute names use two parts: <adjective>_<noun>.

• adjective describes the item, like an adjective.
• noun tells what kind thing it is, like a noun.
• adjective and noun are separated by an underscore _

Tips

• Use the <adjective>_<noun> convention when adding new attributes to this project.
• Try to keep attribute names under 20 characters (see examples for how to maintain descriptivity with this constraint)
• Append new attribute names and description to the appropriate list (heating analysis schema found here) in alphabetical order (add units in the description!).

Examples

• iso3_code is a code (noun) that is of type iso3 (adjective).
• country_name is a name (noun) that is of type country (adjective)
• pop_density is a density (noun) that is of type population shortened to pop (adjective)
• ohfa_factor is a factor (aka coefficient) that is of type ohfa (which is an acronym for 'on-site heated floor area')