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 performance comparisons to docs #53

Open
nickrobinson251 opened this issue Nov 14, 2021 · 0 comments
Open

Add performance comparisons to docs #53

nickrobinson251 opened this issue Nov 14, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation idea needs some investigation before we decide

Comments

@nickrobinson251
Copy link
Owner

nickrobinson251 commented Nov 14, 2021

Now we support v33 data, we can compare against other packages (which seem to only support v33 data), and we might want to add performance comparisons to the docs (see e.g. #47 (comment) for a rough indication).

We'd want to be a bit careful, as it's possible the other packages do other stuff i.e. they don't just parse the data as given, but may also do some "fixing" or "transforming" of the data... but we'd need to investigate to be sure.

Also performance of the parser will depend on what categories make up the data.

One option would be to have a grouped bar chart, comparing perforance on a range of different files (e.g. the files in https://github.com/NREL-SIIP/PowerSystemsTestData/)

(This issue is about performance compared to alternative packages. The issue about tracking the performance of this package itself over time is #54)

@nickrobinson251 nickrobinson251 added documentation Improvements or additions to documentation idea needs some investigation before we decide labels Nov 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation idea needs some investigation before we decide
Projects
None yet
Development

No branches or pull requests

1 participant