Improve doc

[corentinbettiol]

I think the readme or the doc website is missing some explanation regarding the output of the program.

I think that tracarbon.hardware_memory_usage and tracarbon.hardware_cpu_usage are expressed in percentage?

What about tracarbon.co2_emission? What is the unit? Same for tracarbon.energy_consumption.

How to read the json file (or output to stdout)? Do we need to create a graph in order to see the consumption? Do we need to calculate a median or an average value?

[fvaleye]

Hello @corentinbettiol 👋,

Thanks for reporting this!

You are right about the missing documentation on these metrics.
I will take time to improve the documentation to better share the definitions in a coming PR.

In the meantime, I will try to answer your questions.

I think that tracarbon.hardware_memory_usage and tracarbon.hardware_cpu_usage are expressed in percentage?
You are right; these two values are expressed in %:

• hardware_memory_usage: CPU used in % (more information)
• hardware_cpu_usage: memory used in % (more information)

What about tracarbon.co2_emission? What is the unit? Same for tracarbon.energy_consumption.

• tracarbon.co2_emission unit is CO2g/kwh emitted since the last energy measurement measured and the latest carbon emission factor of your location
• tracarbon.energy_consumption is the current wattage of your hardware

How to read the json file (or output to stdout)? Do we need to create a graph in order to see the consumption? Do we need to calculate a median or an average value?

• You could read the JSON by adding all the carbon emissions values based on timestamps; you could easily analyze your carbon emissions for a specific period.
• Or, you could use another exporter to export the values to a graph to analyze the energy consumption and the associated carbon emissions.

[corentinbettiol]

Sorry I missed your comment!

Thanks for the doc on the metrics :)