Skip to content

iotools reference page needs some organization #2446

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

Open
kandersolar opened this issue Apr 23, 2025 · 3 comments · May be fixed by #2447
Open

iotools reference page needs some organization #2446

kandersolar opened this issue Apr 23, 2025 · 3 comments · May be fixed by #2447
Milestone

Comments

@kandersolar
Copy link
Member

The page in question: https://pvlib-python.readthedocs.io/en/latest/reference/iotools.html

The main listing has 40-50 functions. Too many! Let's split it up into smaller listings.

The question is, how should it be split? I suggest organizing by data provider, i.e. separate listings for PVGIS, NSRDB, Solcast, etc.

@cwhanse
Copy link
Member

cwhanse commented Apr 23, 2025

organizing by data provider

gets my vote

@kandersolar kandersolar added this to the v0.12.1 milestone Apr 23, 2025
@kandersolar kandersolar linked a pull request Apr 23, 2025 that will close this issue
4 tasks
@wholmgren
Copy link
Member

At one point we (or at least I) had the thought that the many iotools functions would no longer be imported into the base iotools namespace and users would need to reference the functions in the specific module. I think modifying the documentation to reflect that would be a good first step. I think given the structure of the subpackage, that's a long way of saying +1 for organizing by data provider.

@adriesse
Copy link
Member

There was also some talk of separating iotools from pvlib-python. If that happens the iotools documentation would naturally also be restructured.

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

Successfully merging a pull request may close this issue.

4 participants