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 "powered by pvlib" logos #1277

Merged
merged 8 commits into from Aug 19, 2021
Merged

add "powered by pvlib" logos #1277

merged 8 commits into from Aug 19, 2021

Conversation

cwhanse
Copy link
Member

@cwhanse cwhanse commented Aug 9, 2021

  • [X] Closes #xxxx
  • I am familiar with the contributing guidelines
  • [X] Tests added
  • [x] Updates entries to docs/sphinx/source/api.rst for API changes.
  • Adds description and name entries in the appropriate "what's new" file in 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.
  • Pull request is nearly complete and ready for detailed review.
  • Maintainer: Appropriate GitHub Labels and Milestone are assigned to the Pull Request and linked Issue.

Adds "powered by pvlib" logos to images, and adds request to use these logos to README.

@cwhanse cwhanse added this to the 0.9.0 milestone Aug 9, 2021
Copy link
Member

@wholmgren wholmgren left a 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">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<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">

Copy link
Member

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

@mikofski
Copy link
Member

mikofski commented Aug 9, 2021

FYI: sine the "powered by" is in black, it doesn't show up on dark backgrounds. Should we also have a pair for light background. Lots of folks are using dark mode in GitHub, they may not see it so easily. Here's how it looks for me:
image
I have to sign out to see it:
image

@mikofski
Copy link
Member

mikofski commented Aug 9, 2021

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.

@wholmgren
Copy link
Member

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.

the "powered by" is in black, it doesn't show up on dark backgrounds. Should we also have a pair for light background. Lots of folks are using dark mode in GitHub, they may not see it so easily.

Good idea but I recommend not holding up the PR for that.

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.

Not much, but enough that I can squeeze one into a slide full of logos but not the other.

@mikofski
Copy link
Member

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.

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?

@cwhanse
Copy link
Member Author

cwhanse commented Aug 10, 2021

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?

@wholmgren
Copy link
Member

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.

@wholmgren
Copy link
Member

@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.

@cwhanse
Copy link
Member Author

cwhanse commented Aug 18, 2021

@wholmgren I agree with your suggestion, just haven't made time to execute it. Feel free to push to this PR.

@mikofski
Copy link
Member

I suggest putting the logos in Citing, then moving License to the bottom of the page

+1

@cwhanse
Copy link
Member Author

cwhanse commented Aug 19, 2021

I approve. Thanks @wholmgren

@wholmgren wholmgren merged commit cdb0b12 into pvlib:master Aug 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants