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

EIA V2 documentation #277

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

EIA V2 documentation #277

wants to merge 2 commits into from

Conversation

jleonard8812
Copy link

Are there any particular methods you are hoping to be included in this? And how many examples would you like included?

@kmax12
Copy link
Owner

kmax12 commented Sep 21, 2023

i think showing how to use EIA.get_dataset makes the most sense to start with. I would show example with each of the datasets that we have a handler for here: https://github.com/kmax12/gridstatus/blob/main/gridstatus/eia.py#L628.

@jleonard8812
Copy link
Author

Hey Max! How is this looking for a first pass?

@Michael-fore
Copy link
Contributor

@kmax12

@kmax12
Copy link
Owner

kmax12 commented Nov 9, 2023

hi - sorry, i havent had time to look at this. might not have time for a bit, but ill comment here once i do. really sorry

@kmax12
Copy link
Owner

kmax12 commented Nov 9, 2023

one comment - i see the docs aren't actually building. i think you need to merge in main with this fix #285.

i recommend building docs locally and confirm the interactivity is actually working.

image

@jleonard8812
Copy link
Author

Ah sorry I didn't mean to close this. My local instance of grid status became a mess for some reason and I had corrupted files and ended up just deleting the whole thing and re-cloning. I have the EIA example file..just need to get this PR all sorted..

@jleonard8812
Copy link
Author

6th times the charm...

@jleonard8812 jleonard8812 reopened this Dec 5, 2023
@kmax12
Copy link
Owner

kmax12 commented Dec 7, 2023

the git diff is unreadable since it looks like you committed a bunch of your local dev env. i cant review this until that's cleaned up

Copy link
Collaborator

@WillKoehrsen WillKoehrsen left a comment

Choose a reason for hiding this comment

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

Hey, @jleonard8812 we can try and get this merged if you're still up for it. You'll want to remove the .jupyter_cache/, jupyter_execute/, and gridenv directories from the PR.

@samgdotson
Copy link
Contributor

Is this PR closed by #327?

@WillKoehrsen
Copy link
Collaborator

Is this PR closed by #327?

No, that PR was just fixing existing documentation. It would be great if we could get some more new EIA documentation notebooks.

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

Successfully merging this pull request may close these issues.

None yet

5 participants