Skip to content

Add link to ASV pvlib-benchmarker in documentation #1124

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

Closed
Tracked by #1424
mikofski opened this issue Jan 5, 2021 · 5 comments
Closed
Tracked by #1424

Add link to ASV pvlib-benchmarker in documentation #1124

mikofski opened this issue Jan 5, 2021 · 5 comments
Milestone

Comments

@mikofski
Copy link
Member

mikofski commented Jan 5, 2021

Problem
I can't find any reference or links to the ASV benchmarker in the documentation

Solution
I think a small section with a link to the ASV benchmarker and some discussion about why we benchmark pvlib, how to use read the results, and whatever

Alternatives
There are links in the pull request #1049

Additional context
The benchmarks are really cool, and it's impressive that we have them, so we should advertise and help people use them and solicit their feedback on how we can improve, what's useful, what's not, etc.

@kandersolar
Copy link
Member

ICYMI, there technically is a trail of breadcrumbs that gets you to the benchmark graphs page, but it's a little roundabout:

But it's not very discoverable and can certainly be made more useful.

@mikofski
Copy link
Member Author

mikofski commented Jan 6, 2021

Agh! I searched different variations of benchmark(s) and benchmarker, but not "benchmarking" and evidently the sphinx/rtd search engine is very picky.

@wholmgren
Copy link
Member

wholmgren commented Jan 6, 2021

How about adding to the table of badges in the main readme? e.g.

<a href="https://pvlib-benchmarker.github.io/pvlib-benchmarks/">
<img src="https://img.shields.io/badge/benchmarks-asv-lightgrey" />
</a>

@Naman-Priyadarshi
Copy link
Contributor

Working on this issue @mikofski

@wholmgren
Copy link
Member

closed by #1427

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants