Skip to content

Commit

Permalink
Rc1 cleanup (#215)
Browse files Browse the repository at this point in the history
* remove old examples and subpackages

* fix the broken method attachment

* update docs structure

* remove types from v3 completely

* bump required python version for new features

* change all biner links to be develop_v3 so that the develop_v3 docs link there
  • Loading branch information
RHammond2 authored Oct 14, 2022
1 parent d52f430 commit ade47e4
Show file tree
Hide file tree
Showing 15 changed files with 38 additions and 4,690 deletions.
26 changes: 18 additions & 8 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,28 @@
# Changelog
All notable changes to this project will be documented in this file. If you make a notable change to the project, please add a line describing the change to the "unreleased" section. The maintainers will make an effort to keep the [Github Releases](https://github.com/NREL/OpenOA/releases) page up to date with this changelog. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

## [UNRELEASED]
## 3.0rc1
- The package name is changed from `operational_analysis` to `openoa` to be more consistent with how we expect to import OpenOA!
- Renamed plant_analysis to long_term_monte_carlo_aep and updated it for the V3 API.
- `PlantData` is now fully based on attrs dataclasses and utilizing the pandas `DataFrame` for all internal data structures
- `PlantData` can now be imported via `from openoa import PlantData`
- By using attrs users no longer have to subclass `PlantData` and create their own `PlantData.prepare` method.
- Users can now bring their own column naming, and provide a metadata definition so columns are mapped under the hood through the `PlantMetaData` class (see Intro Example for more information!)
- `PlantData.scada` (or similar) is now used in place of accessing the SCADA (or similar) dataframe
- v2 `ReanalysisData` and `AssetData` methods have been absorbed by `PlantData` in favor of a unified data structure and means to operate on data.
- v2 `TimeSeriesTable` is removed in favor of a pandas-based API and data usage
- openoa has a new import structure
- `PlantData` is available at the top level: `from openoa import PlantData`
- tookits -> utils via `from openoa.utils import xx`
- pandas_plotting -> plot
- quality_check_automation -> qa (formerly located in methods)
- methods -> analysis via `from openoa.analysis import xx`
- Convenience methods such as `PlantData.turbine_ids` or `PlantData.tower_df(tower_id="x")` have been added to address commonly used code patters
- Analysis methods are now available through `from openoa.analysis import <AnalysisClass>`
- Renamed `compute_shear_v3` to `compute_shear` and deleted old version of `compute_shear`.
- v2 `ReanalysisData` and `AssetData` methods have been absorbed by `PlantData` in favor of a unified data structure and means to operate on data.
- v2 `TimeSeriesTable` is removed in favor of a pandas-based API and data usage
- The `filters` and `imputing` module has been cleaned up to take both pandas `DataFrame` and `Series` objects where appropriate, refactors pandas code to be much cleaner for performance and readability, has more user-friendly error messages, and has more consist outputs
- The `utils` subpackage has been cleaned up to take both pandas `DataFrame` and `Series` objects where appropriate, refactors pandas code to be much cleaner for both performance and readability, has more user-friendly error messages, and has more consist outputs
- `openoa.utils.imputing.correlation_matrix_by_id_column` has been renamed to `openoa.utils.imputing.asset_correlation_matrix`
- A new 00_x example notebook is replace the 1a/b QA examples to highlight how the `project_ENGIE.py` methods are created. This creates an example for users to work with and significantly more details on how to use the new `PlantData` and `PlantMetaData` methods.

## [UNRELEASED - 2.x]
- Added `compute_shear_v3` to `met_data_processing` toolkit, improving efficiency, removed requirement to provide reference height, and added option to return reference height and wind speed corresponding to best-fit shear exponent. Decided to bifurcate function into `compute_shear` and `compute_shear_v3` in order to maintain backwards compatibility with the OpenOA 2.x line.
- Documentation reorganization and cleanup

## [2.3 - 2022-01-18]
- Replaced hard-coded reanalysis dates in plant analysis with automatic valid date selection and added optional user-defined end date argument. Fixed bug in normalization to 30-day months.
Expand Down
536 changes: 0 additions & 536 deletions examples/00_toolkit_examples_entr.ipynb

This file was deleted.

Loading

0 comments on commit ade47e4

Please sign in to comment.