CO2Toolkit 0.2.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package CO2Toolkit --version 0.2.0
                    
NuGet\Install-Package CO2Toolkit -Version 0.2.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="CO2Toolkit" Version="0.2.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="CO2Toolkit" Version="0.2.0" />
                    
Directory.Packages.props
<PackageReference Include="CO2Toolkit" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add CO2Toolkit --version 0.2.0
                    
#r "nuget: CO2Toolkit, 0.2.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#addin nuget:?package=CO2Toolkit&version=0.2.0
                    
Install CO2Toolkit as a Cake Addin
#tool nuget:?package=CO2Toolkit&version=0.2.0
                    
Install CO2Toolkit as a Cake Tool

OpenSSF Scorecard License: MIT

CO2 Toolkit for DotNet

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 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.

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.

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");

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
  • newVisitorRatio [0-1]: A value that represents the number of website visitors who have never visited your page.
  • dataCacheRatio [0-1]: The ratio of data that is cached for returning visitors.
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.

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})");

Acknowledements

All calculations are based on averaged (yearly) CO2 intensity data from the Ember Electricity Data Explorer (CC-BY-4.0) and are implemented using the Sustainable Web Design Model (Version 4).

License

This package is licensed under the MIT License. See the LICENSE file for more details.

Contributions

Contributions are welcome! Please read Contributing to see how you can help improve this package!

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETStandard 2.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.4.0 89 5/18/2025
0.3.0 158 4/10/2025
0.2.0 121 4/4/2025
0.1.0 167 4/3/2025