Finish FlascDataFrame (Paul) #215
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
misi9170
approved these changes
Oct 16, 2024
misi9170
added a commit
that referenced
this pull request
Oct 17, 2024
* Add new `FlascDataFrame` object to enhance user interface with data (#199) * Adding at the root level for now; could consider moving to utilities/ * Ruff. * precommit stuff. * Add example notebook * Add wide to long * Add test * Update README.md engagement * Update README.md replacing 'FLORIS' typo * Feature/add docstrings (#197) * Update to 15 (#202) * Update for PyPI installation. (#204) * Update version number; ignore version.py for ruff. * Adhere to FLASC formatting rules. * psuedocode for conversions. Tests for saving dataframe to file. * Print warning when to_feather used. * String formatting. * Add several more tests and n_turbines property. * Adding TODOs for long/wide conversions. * Clean up, a few more tests. * Improved printout. * ruff format. --------- Co-authored-by: Paul <paul.fleming@nrel.gov> Co-authored-by: christiannvaughn <139596563+christiannvaughn@users.noreply.github.com> * Add dataframe conversions to flascdataframe (#211) * Add wind up example using `FlascDataFrame` (#210) * loosen wind-up dependency * Finish FlascDataFrame (Paul) (#215) Add type hints * Finish FlascDataFrame (update examples/docs) (#219) * Merge recent changes. * Update functions to use FlascDataFrames; getter and setter for channel_name_map; metadata copying method. * Smarteole examples now using FlascDataFrame * Add brief demonstration of switch to user data format; rename 09 notebook for clarity. * Update artifical data examples. * Had weird behavior in the getter/setter caused by not providing the true underlying attribute in _metadata. * formatting. * Simplify imports of FlascDataFrame throughout. * Add wind-up to pyproject.toml after setup.py was removed. * Update docs for FlascDataFrame (#220) --------- Co-authored-by: misi9170 <39596329+misi9170@users.noreply.github.com> Co-authored-by: christiannvaughn <139596563+christiannvaughn@users.noreply.github.com> Co-authored-by: Alex Clerc <alex.clerc@res-group.com> Co-authored-by: misi9170 <michael.sinner@nrel.gov>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Finish FlascDataFrame
Type Hints
This PR goes through code and updates type hints and docstrings where pd.Dataframe is called for and adds the option for FlascDataFrame to be used as well to clarify code docs.
Note code mostly updates existing type hints, but where type hints aren't used updates docstrings. Getting to uniform type hinting and type hinting style can be a future project
Remove time requirement
Removes requirements time column is included, as this will necessarily be violated in certain conditions
Add test of
FlascDataFramedriving energy ratioAdd a test that initiating an energy ratio analysis with
FlascDataFrameis okAdd test
FlascDataFramedriving time operationsAdd. to df_time_operations_test.py some additional testing ensuring matching results when using
FlascDataFrameas input