Skip to content

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

How to organize the example gallery? #1271

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
kandersolar opened this issue Aug 7, 2021 · 1 comment
Closed

How to organize the example gallery? #1271

kandersolar opened this issue Aug 7, 2021 · 1 comment

Comments

@kandersolar
Copy link
Member

The example gallery now has 17 items and might benefit from being organized into sections. This has been briefly discussed elsewhere:

I think the sphinx configuration changes to do this would be straightforward (see here). The question is how the gallery should be organized. For inspiration, here are some other packages with sections in their gallery:

To get the conversation started, here are some categorizations mentioned in the above threads:

  • by abstraction level: functions vs objects
  • by task (or "how do I"), e.g. system modeling vs resource assessment vs ...
  • by modeling topic, roughly along the lines of the pvlib module breakdown and PVPMC diagram

Input from anyone is welcome!

@mikofski
Copy link
Member

mikofski commented Aug 7, 2021

I think I like by module? EG:

  • solar position
  • irradiance
  • atmosphere
  • clearsky
  • PV modules
  • inverters
  • IO
  • IV curves
  • PV systems
  • etc

This could incorporate both topics and abstraction level, bc objects tend to aggregate several functions across topics. Each section could have both "how to's" and other less general examples

@pvlib pvlib locked and limited conversation to collaborators Aug 11, 2021

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

Projects
None yet
Development

No branches or pull requests

2 participants