https://github.com/richilino/co2-toolkit-net
A simple NuGet package to calculate CO2 emissions during data transfer.
https://github.com/richilino/co2-toolkit-net
carbon-emissions carbon-footprint co2 co2-emissions dotnet sustainable-software sustainable-web-design-model
Last synced: about 1 month ago
JSON representation
A simple NuGet package to calculate CO2 emissions during data transfer.
- Host: GitHub
- URL: https://github.com/richilino/co2-toolkit-net
- Owner: richilino
- License: mit
- Created: 2025-04-03T16:09:05.000Z (about 2 months ago)
- Default Branch: master
- Last Pushed: 2025-04-10T18:11:00.000Z (about 1 month ago)
- Last Synced: 2025-04-10T18:52:54.428Z (about 1 month ago)
- Topics: carbon-emissions, carbon-footprint, co2, co2-emissions, dotnet, sustainable-software, sustainable-web-design-model
- Language: C#
- Homepage: https://www.nuget.org/packages/CO2Toolkit
- Size: 75.2 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://www.nuget.org/packages/CO2Toolkit)
[](https://scorecard.dev/viewer/?uri=github.com/richilino/co2-toolkit-net)
[](/LICENSE.md)
# :seedling: CO2 Toolkit for .NET
The **CO2Toolkit** NuGet package provides an easy way to estimate the carbon emissions associated with the consumption of digital content. This package uses the Sustainable Web Design Model V4 from [Sustainable Web Design](https://sustainablewebdesign.org/estimating-digital-emissions/) to calculate the carbon footprint based on various factors such as the amount of data transferred, the energy efficiency of data centres, networks and user devices, and the carbon intensity of the grid.
With the growing need for more sustainable digital practices, this package provides a simple and accurate way to estimate the environmental impact of digital assets, making it easier to assess and optimise the carbon emissions associated with modern .NET applications.
**Key Features:**
- :earth_africa: Includes recent CO2 emission data for 200+ regions of the world!
- :rocket: State of the Art CO2 emission model!
- :brain: Simple and easy to use!
- :lock: Developed using modern security practices with [verifiable provenance](#provenance)!
- :white_check_mark: [OSI approved](https://opensource.org/license/mit) and [GPL compatible](https://wiki.gentoo.org/wiki/License_groups/GPL-COMPATIBLE) license!
## Usage
### CO2Calculator Class
The core functionality of this package is provided by the `CO2Calculator` class, which can be used to calculate the carbon emissions for data transfers.
```csharp
using CO2Toolkit;
// Calculation based on World Average Carbon Grid Emissions (2023)
var co2Calculator = new CO2Calculator();
// Example: Estimate emissions for 1 GB of data transfer
var bytesTransferred = 1_073_741_824;
var emissions = co2Calculator.BytesToEmission(bytesTransferred);
Console.WriteLine($"Estimated CO2e emissions: {emissions} grams");
```
By default, emissions are calculated using conservative / pessimistic assumptions. If you have more detailed information about your user base and infrastructure, calculations can be further adjusted by passing the following options:
- **greenHostingFactor [0-1]**: A value of 0 means 0% of your hosting provider's used power comes from renewable or zero-carbon sources. Conversely, a value of 1 means 100% of your hosting provider's used power comes from renewable or zero-carbon sources. *(Default: 0)*
- **newVisitorRatio [0-1]**: A value that represents the number of website visitors who have never visited your page. *(Default: 1)*
- **dataCacheRatio [0-1]**: The ratio of data that is cached for returning visitors. *(Default: 0)*
```csharp
var co2Calculator = new CO2Calculator(
greenHostingFactor: 0.4, // 40% of power from renewables
newVisitorRatio: 0.5, // 50% of users have never been on your site
dataCacheRatio: 0.75 // 75% of content is cached for returning users
);
```
If you need a more accurate calculation based on a certain geography, check if your desired region is available in the `ZoneRepository`. This will change the CO2 intensity for the _Operational Energy_ needed to transfer data.
```csharp
using CO2Toolkit;
// Calculation based on German Average Carbon Grid Emissions
var co2Calculator = new CO2Calculator(zone: ZoneRepository.Germany);
// Example: Estimate emissions for 1 GB of data transfer
var bytesTransferred = 1_073_741_824;
var emissions = co2Calculator.BytesToEmission(bytesTransferred);
Console.WriteLine($"Estimated CO2e emissions: {emissions} grams (${ZoneRepository.Germany.Name}, ${ZoneRepository.Germany.Year})");
```
### Documentation
Read about these features and more in our [documentation](https://github.com/richilino/co2-toolkit-net/wiki):
* Simple Emission Calculation
* Zones with Custom Energy Mix
* more coming soon...
## Provenance
Released package attestations can be verified using the GitHub CLI. Adjust the package name and execute the command below in the directory where the .nupkg is located.
```bash
gh attestation verify CO2Toolkit.X.X.X.nupkg --owner richilino --predicate-type https://spdx.dev/Document/v2.3
```
For more detailed attested SBOM information, pass the `--format json` argument as well.
## Acknowledements
All calculations are based on averaged (yearly) CO2 intensity data from the [Ember Electricity Data Explorer (CC-BY-4.0)](https://ember-energy.org/) and are implemented using the [Sustainable Web Design Model (Version 4)](https://sustainablewebdesign.org/).
## License
This package is licensed under the MIT License. See the [LICENSE](LICENSE.md) file for more details.
## Contributions
Contributions are welcome! Please read [Contributing](/CONTRIBUTING.md) to see how you can help improve this package!