$ show Green-Software-Foundation/sci
This repository hosts the Software Carbon Intensity (SCI) specification, a standardized methodology for measuring and reporting the carbon emissions of software systems as a rate (emissions per functional unit). The core artifact is SPEC.md, which defines the SCI calculation framework including formulas for operational and embodied emissions, guidance on system boundaries and functional units, and quantification methods. The repository also includes a static website (generated from SPEC.md) that presents the specification, an example case study demonstrating application of the methodology to a real web application (eShoppen), and automation for building and deploying the site. While the repository does not process data or implement the SCI calculation itself, it provides a complete, reusable framework for software carbon measurement that defines how to collect, transform, and interpret emissions data.
The LLM identified 3 files worth highlighting for reuse:
Defines a GitHub Actions workflow for deploying static documentation sites to GitHub Pages. Solves the recurring problem of automating documentation deployment with minimal configuration. The workflow is parameterized (branch name, build steps) and demonstrates CI/CD best practices including concurrency management, proper permissions, and structured job steps. While focused on deployment rather than direct data operations, it enables reliable distribution of data documentation and reports, making it a valuable reusable component for data projects that publish results as static sites.
Processes markdown specification with frontmatter to generate a styled HTML documentation site. Implements a clean, reusable pattern for documentation generation: extracting frontmatter with gray-matter, applying custom markdown rendering (for anchored headings), and embedding content in a full HTML template. The core logic (frontmatter extraction → custom rendering → templating) is abstracted from specific filenames and could be adapted to other documentation projects with minimal changes. Demonstrates solid engineering in separating concerns and handling metadata, providing a foundation for consistent documentation generation across data projects.
Contains the SCI calculation methodology, a reusable framework for measuring software carbon intensity as a rate. Defines the complete analytical approach: SCI = (O + M) per R where O is operational emissions (energy × carbon intensity), M is embodied emissions (amortized hardware footprint), and R is the functional unit. Includes detailed guidance on system boundaries, functional unit selection, quantification methods (measurement vs. modeling), and baseline comparison. The methodology is designed to be universally applicable across software systems (from embedded devices to cloud services) with clear instructions for adaptation. Represents a structured, comprehensive approach to sustainability measurement that solves the recurring need for standardized environmental impact assessment in software.