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

Data retrieval #4

Open
AdamRJensen opened this issue Dec 8, 2022 · 3 comments
Open

Data retrieval #4

AdamRJensen opened this issue Dec 8, 2022 · 3 comments

Comments

@AdamRJensen
Copy link
Member

I suppose the guide is missing a very basic page on "how to get data", just a simple demonstration on how to use pvlib and a link to where one can obtain an API key.

@kandersolar
Copy link
Member

My original plan for this project was to only document things that cannot be found elsewhere (although I see I have weakened it "not necessarily"...):

Rather, it is a user-developed effort to document and demonstrate aspects of the PSM3 dataset and web API that are not necessarily documented anywhere else

It seemed like a good idea to me in part because I don't see much value in duplicating info from the pvlib & NSRDB API docs, and in part because I didn't want to be responsible for maintaining any more information than I had to. But I am open to changing that stance now that the project has opened up. What do you think @AdamRJensen?

@AdamRJensen
Copy link
Member Author

Now that it's public I could easily that 90% of people stumbling upon the guide, are just looking for the very basics. So it seems a bit silly to not ever show how to get the data. It can be a very simple half-page description. Otherwise, I'm happy to keep the scope as is.

@kandersolar
Copy link
Member

I have been thinking of organizing the pages into related topics, for example the details of the solar position calculation would be in a different section from the API rate limits. So perhaps there could be a section on the basics or "getting started" or something, and it could point readers to the more official documentation as well. That sounds okay to me!

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

No branches or pull requests

2 participants