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 "powered by pvlib" logos #1277
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice!
Rendering available here: https://github.com/cwhanse/pvlib-python/tree/logos
Is there a good place to put them in the main documentation? Perhaps in the citing section of https://pvlib-python.readthedocs.io/en/stable/? code in docs/sphinx/source/index.rst
README.md
Outdated
|
||
If you use pvlib-python in a commercial or publicly-avaiable application, please consider displaying one of the "powered by pvlib" logos: | ||
<img src="docs/sphinx/source/_images/pvlib_powered_logo_horiz.png" width="300"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
<img src="docs/sphinx/source/_images/pvlib_powered_logo_horiz.png" width="300"> | |
<img src="docs/sphinx/source/_images/pvlib_powered_logo_horiz.png" width="300"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the blank line will improve layout
Also, TBH, there's not much difference between the horizontal and vertical, that is the "powered by" vertical version is not as vertical as the plain version. |
How do we feel about putting the logos in the license section of the README and the documentation? I'm a little uneasy about it. I feel like the license is exactly BSD-3, no more and no less. The logo feels much more like a citation to me.
Good idea but I recommend not holding up the PR for that.
Not much, but enough that I can squeeze one into a slide full of logos but not the other. |
I agree, that troubled me too. We want to encourage logos but they're not required nor part of license. How about a new section called logos? |
My thinking was that someone interested in using pvlib would look in the license section, and someone writing about using pvlib would look at the citation section. I did not mean for the text to be in addition to the license, but rather, as a comment about using pvlib. If the information is in the Citing section (near the bottom of the page) my hesitation is that it may not be viewed. I'm -1 on a new section titled Logos. Open to other ideas: rename License to Using pvlib? Put this at the end of the top section? Move Citing up? |
I could be wrong, but I am guessing that the few people interested in knowing what the license actually is are also those that will actively search for it. So I would be fine demoting it to the bottom of both the documentation and the README, especially since GitHub now highlights it in the About section of the repository. I'm -1 on renaming License. I'm fine with a new section for Logos, though I think in the long run we might need to put them on a page with usage guidelines. |
@cwhanse how do you want to proceed here? @mikofski and I agree that we should maintain the purity of the license section. For a quick win that can be modified later, I suggest putting the logos in Citing, then moving License to the bottom of the page. I'm also happy to push to the PR if you're done trying to guess at what would make me happy. |
@wholmgren I agree with your suggestion, just haven't made time to execute it. Feel free to push to this PR. |
+1 |
I approve. Thanks @wholmgren |
[X] Closes #xxxx[X] Tests added[x] Updates entries todocs/sphinx/source/api.rst
for API changes.docs/sphinx/source/whatsnew
for all changes. Includes link to the GitHub Issue with:issue:`num`
or this Pull Request with:pull:`num`
. Includes contributor name and/or GitHub username (link with:ghuser:`user`
).[x] New code is fully documented. Includes numpydoc compliant docstrings, examples, and comments where necessary.Adds "powered by pvlib" logos to images, and adds request to use these logos to README.