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

Add a model object to trace function outputs #232

Open
fershad opened this issue Oct 14, 2024 · 1 comment
Open

Add a model object to trace function outputs #232

fershad opened this issue Oct 14, 2024 · 1 comment
Labels
designing Specific outcomes to address, but that we’re not committing to enhancement New feature or request hacktoberfest roadmap

Comments

@fershad
Copy link
Contributor

fershad commented Oct 14, 2024

Is your feature request related to a problem? Please describe.
This is related to the scenario outlined by @benjaminrancourt in #195 (comment)

Describe the solution you'd like
The proposed solution would add a model object to the output of the perByteTrace and perVisitTrace functions. This would contain information about the model used for the carbon estimates calculation, as well as information about any constants that are in the model. This additional context would be useful for people trying to reproduce the results of a given estimate - Hey, if you want to reproduce these results, here are all the assumptions that has been made.

@fershad fershad added enhancement New feature or request roadmap labels Oct 14, 2024
@fershad
Copy link
Contributor Author

fershad commented Oct 14, 2024

The expected output would look something like this:

{
        "co2": {
          ...
        },
        "green": true,
        "variables": {
          ...
        },
       "model": {
           "name": "Sustainable Web Design Model",
           "version": 3,
           "shorthand": "swdmv3",
           "constants": {
               ... // a list of constants & their values here
            }
       }
}

@fershad fershad added the designing Specific outcomes to address, but that we’re not committing to label Nov 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
designing Specific outcomes to address, but that we’re not committing to enhancement New feature or request hacktoberfest roadmap
Projects
None yet
Development

No branches or pull requests

1 participant