Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Documentation on Estimation of Equivalent Usage Emissions #749

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

IamLRBA
Copy link

@IamLRBA IamLRBA commented Dec 18, 2024

As per issue #733
cc
@benoit-cty
I Added a new section in the methodology.rst.txt file explaining equivalent usage emissions.

Signed-off-by: Jerry Laruba Festus <jerrylarubafestus@gmail.com>
Copy link
Contributor

@benoit-cty benoit-cty left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, I'm always happy to see new contributor !

I suggest some changes and can you add the US citizen impact ?

docs/_sources/methodology.rst.txt Outdated Show resolved Hide resolved
docs/_sources/methodology.rst.txt Outdated Show resolved Hide resolved
docs/_sources/methodology.rst.txt Outdated Show resolved Hide resolved
IamLRBA and others added 2 commits December 18, 2024 14:54
Co-authored-by: Benoit Courty <6603048+benoit-cty@users.noreply.github.com>
Co-authored-by: Benoit Courty <6603048+benoit-cty@users.noreply.github.com>
Copy link
Author

@IamLRBA IamLRBA left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the corrections @benoit-cty

docs/_sources/methodology.rst.txt Outdated Show resolved Hide resolved
Signed-off-by: Jerry Laruba Festus <jerrylarubafestus@gmail.com>
Copy link
Author

@IamLRBA IamLRBA left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@benoit-cty these are the changes as per your review. If there are any more corrections you'd need just let me know.
Thanks!

@benoit-cty
Copy link
Contributor

Thanks, can you add the calculus for the US Citizen ?

We based our calculus on an average annual emission of 13.3 Tons of CO2.eq for a US citizen. And we divide it per 52 weeks per year.

@IamLRBA
Copy link
Author

IamLRBA commented Dec 19, 2024

Thanks, can you add the calculus for the US Citizen ?

We based our calculus on an average annual emission of 13.3 Tons of CO2.eq for a US citizen. And we divide it per 52 weeks per year.

Thank you for the feedback @benoit-cty !

PR Update: Added Calculations for US Citizen Weekly Emissions

I've made the following updates to address your request:

  1. Added Calculations for US Citizen Weekly Emissions:

    • Based on the average annual emissions of 13.3 tons CO₂ equivalent for a US citizen,
    • I calculated weekly emissions as:
      [
      \text{Weekly Emissions} = \frac{13.3}{52} \approx 0.256 , \text{tons CO₂ equivalent per week.}
      ]
    • I incorporated this into the documentation, providing the formula and examples for clarity.
  2. I updated Documentation Structure:

    • Added a new section titled "US Citizen Weekly Emissions" to present the information.
    • I then clarified how total emissions can be compared to this benchmark.

The revised documentation now includes:

  • A breakdown of equivalent usage comparisons for cars, TVs, and US Citizen emissions.
  • Clear formulas and examples for each comparison.

Please let me know if there's anything else you'd like me to adjust! 🚀

@IamLRBA
Copy link
Author

IamLRBA commented Dec 20, 2024

@benoit-cty in this new commit i'm aiming to solve issue #751

@benoit-cty
Copy link
Contributor

I really appreciate your contribution, but please do a separate PR for RAM. Because we can't change something like that in a minor version as it will impact people making comparison between run over time. Changing RAM value must be in a V3 of CodeCarbon.

@IamLRBA
Copy link
Author

IamLRBA commented Dec 21, 2024

I really appreciate your contribution, but please do a separate PR for RAM. Because we can't change something like that in a minor version as it will impact people making comparison between run over time. Changing RAM value must be in a V3 of CodeCarbon.

THanks for your reply @benoit-cty. I will do that.

@benoit-cty
Copy link
Contributor

benoit-cty commented Dec 22, 2024

Hello,
You change _sources/methodology.rst.txt, but for Sphinx it is the docs/edit/methodology.rst that need to be change and Sphinx create the txt and then the html.

You can generate the doc locally with hatch run docs:build (See https://github.com/mlco2/codecarbon/blob/master/CONTRIBUTING.md#installation ) if you want to check that everything is fine by opening index.html.

@benoit-cty benoit-cty linked an issue Dec 22, 2024 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation on estimation of equivalent usage emissions
2 participants