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

[Enhancement] Reorganize artifical data examples to make them easier to follow #117

Merged
merged 13 commits into from
Aug 31, 2023

Conversation

misi9170
Copy link
Collaborator

@misi9170 misi9170 commented Aug 31, 2023

Ready for review and possible merge.

Feature or improvement description
Some reorganization of the examples was needed for clarity. In particular,

  1. A subdirectory names examples/ still existed under the flasc/ source code directory, which contained example input files and a utility for loading them but no example code.
  2. The artificial_data examples were not clearly laid out

These have now been addressed by

  1. Moving models.py up to flasc/ and renaming it utilties_examples.py and moving the example input files to their respective examples_ directories (examples_smarteole/ and examples_artifical_data/)
  2. Numbering the subdirectories and files within the subdirectories of examples_artifical_data/

Related issue, if one exists
#113

Impacted areas of the software
examples_artifical_data/, examples_smarteole/, flasc (to a small extent)

Aditional notes

  • A small bugfix was also made to handle the default behavior of plot_energy_ratio() from energy_ratio_output.py when polar_plot = True.
  • This PR removes @Bartdoekemeijer 's old NREL email address and supplies @paulf81 and @misi9170 's ones instead
  • A final small bugfix moves changes some polars commands to update to syntax and updates polars version requirement to 0.19.0

Test results, if applicable
Test pass after polars update

@paulf81
Copy link
Collaborator

paulf81 commented Aug 31, 2023

Modified the description to include the small polars bugfix

Copy link
Collaborator

@paulf81 paulf81 left a comment

Choose a reason for hiding this comment

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

This looks great @misi9170 , thank you! I pulled it down and tested examples and everything ran well, thank you!

@paulf81 paulf81 merged commit 685871d into NREL:develop Aug 31, 2023
6 checks passed
@misi9170 misi9170 mentioned this pull request Oct 26, 2023
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.

2 participants