Python package for OpenEI EULP downloads#1300
Conversation
Python modules with functions for downloading, plotting, and calculating statistics from the End Use Load Profile data on OpenEI. Sample Python script with documentation to test modules. Readme with general instructions. This addresses #539 while we work with REopt and DGen teams on a process to identify a smaller set of representative buildings.
brtietz
left a comment
There was a problem hiding this comment.
Code looks well organized and well commented, but I got bogged down testing with missing dependencies. Please either add a complete list of dependencies to the README or add a conda environment yml file:
I'll take another run at testing once that's there.
|
|
||
| * `stats`: Functions to calculate total and peak load values from the downloaded data. | ||
|
|
||
| To use the package, copy the `eulp` folder to the folder containing your Python script, and import the package with: |
There was a problem hiding this comment.
I always appreciate when packages explicitly state what they depend upon. I'm open to either a list in the README, or a conda yml file: https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#create-env-file-manually
There was a problem hiding this comment.
Good point. How about adding a requirements.txt file along with a list of required packages in the readme? See 74da475.
There was a problem hiding this comment.
Thanks, I added two additional packages I needed to run it.
| D = plot.clean_plot_data(df, bldg_id) | ||
| df = D['df_clean'] | ||
|
|
||
| plot.plot_full_year(df.filter(items=['total']), bldg_id, 'Total Load') # total load over year |
There was a problem hiding this comment.
I like having plots here, but can you add units? I think its kW, but having the explicit axis labels would be super helpful.
There was a problem hiding this comment.
Yes, thanks for pointing out that omission. I added a "kW" label to the y-axis for all plots.
Fix clean_plot() parameters in plot.py main() function.
brtietz
left a comment
There was a problem hiding this comment.
Thanks for adding the requirements and labels! Ready to merge.
Merge patch into develop
Merge patch
…into open_ei_load_data_patch
|
@cpaulgilman The test failures look like they're due to a problem that's already been solved on patch. I think I might be able to fix it by cherry-picking the commits from 12/9 and 12/12 to a branch from the latest patch. Any objections to me closing this PR and trying that approach? |
|
I've moved the commits that aren't merge commits to #1331. Fingers crossed that the tests pass, closing this with a sense of optimism. |
Add Python package to SAM samples folder to provide a way for SAM users to get load data from OpenEI End User Load Profiles database to use in SAM.
Partially address #539
Type of change
Please delete options that are not relevant.
Checklist:
If you have added a new compute module in a SSC pull request related to this one, be sure to check the Process Requirements.