|
1 | 1 | # Changelog |
2 | 2 | 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/). |
3 | 3 |
|
4 | | -## [UNRELEASED] |
| 4 | +## 3.0rc1 |
5 | 5 | - The package name is changed from `operational_analysis` to `openoa` to be more consistent with how we expect to import OpenOA! |
6 | | -- Renamed plant_analysis to long_term_monte_carlo_aep and updated it for the V3 API. |
| 6 | +- `PlantData` is now fully based on attrs dataclasses and utilizing the pandas `DataFrame` for all internal data structures |
| 7 | + - `PlantData` can now be imported via `from openoa import PlantData` |
| 8 | + - By using attrs users no longer have to subclass `PlantData` and create their own `PlantData.prepare` method. |
| 9 | + - 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!) |
| 10 | + - `PlantData.scada` (or similar) is now used in place of accessing the SCADA (or similar) dataframe |
| 11 | + - v2 `ReanalysisData` and `AssetData` methods have been absorbed by `PlantData` in favor of a unified data structure and means to operate on data. |
| 12 | + - v2 `TimeSeriesTable` is removed in favor of a pandas-based API and data usage |
| 13 | +- openoa has a new import structure |
| 14 | + - `PlantData` is available at the top level: `from openoa import PlantData` |
| 15 | + - tookits -> utils via `from openoa.utils import xx` |
| 16 | + - pandas_plotting -> plot |
| 17 | + - quality_check_automation -> qa (formerly located in methods) |
| 18 | + - methods -> analysis via `from openoa.analysis import xx` |
| 19 | +- Convenience methods such as `PlantData.turbine_ids` or `PlantData.tower_df(tower_id="x")` have been added to address commonly used code patters |
| 20 | +- Analysis methods are now available through `from openoa.analysis import <AnalysisClass>` |
7 | 21 | - Renamed `compute_shear_v3` to `compute_shear` and deleted old version of `compute_shear`. |
8 | | -- v2 `ReanalysisData` and `AssetData` methods have been absorbed by `PlantData` in favor of a unified data structure and means to operate on data. |
9 | | -- v2 `TimeSeriesTable` is removed in favor of a pandas-based API and data usage |
10 | | -- 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 |
| 22 | +- 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 |
11 | 23 | - `openoa.utils.imputing.correlation_matrix_by_id_column` has been renamed to `openoa.utils.imputing.asset_correlation_matrix` |
12 | 24 | - 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. |
13 | | - |
14 | | -## [UNRELEASED - 2.x] |
15 | | -- 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. |
| 25 | +- Documentation reorganization and cleanup |
16 | 26 |
|
17 | 27 | ## [2.3 - 2022-01-18] |
18 | 28 | - 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. |
|
0 commit comments