Release 3.1.0

[martin-springer]

This pull request implements the v3.1.0 release, focusing on improved compatibility with Python 3.13, pandas 3.0, numpy 2.x, and xgboost 3.x, as well as enhancements to the clipping filter and warning messages. It also removes deprecated normalization functions and updates documentation and requirements. The most significant changes are summarized below.

Enhancements and Feature Changes

• The clip_filter in TrendAnalysis._filter() now supports using pv_energy when pv_power is unavailable, and enforces a median time step of 60 minutes or less for clipping detection, raising a ValueError otherwise. This improves support for sub-hourly, energy-based analyses and ensures data quality. [1] [2]
• Added stacklevel to all warnings.warn() calls so warning messages now point to user code rather than internal library code, improving user experience and debugging. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10]

Compatibility and Requirements Updates

• Updated the test matrix to include Python 3.13 and removed Python 3.9, and excluded clip_filter tests for unsupported environments.
• Updated requirements to ensure compatibility with Python 3.13, pandas 3.0, numpy 2.x, xgboost 3.x, and other dependencies. Upper version restrictions for pandas and numpy were removed, and many package versions were bumped for compatibility and security.
• Fixed pandas 3.0 compatibility in normalization.py by using .total_seconds() instead of .view('int64') for datetime calculations, and updated Timedelta strings from 'd' to 'D' to address deprecation warnings. [1] [2] [3]
• Fixed numpy 2.x compatibility in soiling.py by using .item() and explicit indexing to extract scalars.
• Fixed xgboost 3.x compatibility in filtering.xgboost_clip_filter() by using xgb.DMatrix with explicit feature names for model prediction. [1] [2] [3]

Deprecations and Removals

• Removed the deprecated normalization.delta_index and normalization.check_series_frequency functions (deprecated since v2.0.0); private helpers remain for internal use. [1] [2] [3]

Documentation

• Added the v3.1.0 changelog and updated example notebooks to use the modern temperature coefficient (gamma_pdc). [1] [2]
• Improved nbval sanitization rules in documentation to handle stacklevel changes in warnings and updated regex indices.

Please refer to the new changelog/v3.1.0.rst for a detailed list of all enhancements, bug fixes, and requirements changes.

• Code changes are covered by tests
• Code changes have been evaluated for compatibility/integration with TrendAnalysis
• New functions added to __init__.py
• API.rst is up to date, along with other sphinx docs pages
• Example notebooks are rerun and differences in results scrutinized
• Updated changelog

[codecov-commenter]

Codecov Report

❌ Patch coverage is 98.03922% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 96.18%. Comparing base (076ebff) to head (aac4765).

Files with missing lines	Patch %	Lines
rdtools/normalization.py	96.66%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #485   +/-   ##
=======================================
  Coverage   96.17%   96.18%           
=======================================
  Files          12       12           
  Lines        2276     2280    +4     
=======================================
+ Hits         2189     2193    +4     
  Misses         87       87           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[Copilot]

Pull request overview

This PR packages the v3.1.0 release, primarily updating rdtools for compatibility with newer Python and scientific Python ecosystems (Python 3.13, pandas 3.x/numpy 2.x/xgboost 3.x), improving clip_filter behavior in TrendAnalysis, and making warnings point to user code via stacklevel.

Changes:

• Update dependencies/CI to target newer runtimes and libraries (incl. Python 3.13) and adjust warning filtering/sanitization for notebooks.
• Modernize pandas/numpy/xgboost compatibility in core time-series utilities (normalization, soiling, filtering) and add clip_filter frequency validation.
• Update docs/changelog/API docs to reflect removals of deprecated normalization functions and new release notes.

Reviewed changes

Copilot reviewed 19 out of 24 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
setup.py	Bumps test requirements and adjusts install requirements/classifiers for newer Python ecosystem.
setup.cfg	Adds pytest filterwarnings entry for a new deprecation warning.
requirements.txt	Pins updated dependency versions for compatibility/security.
.github/workflows/pytest.yaml	Updates CI matrix to test Python 3.10–3.13.
rdtools/analysis_chains.py	Enhances clip_filter to use energy if needed and enforces ≤60 min median timestep; adds stacklevel to warnings.
rdtools/filtering.py	Updates XGBoost clipping prediction path for xgboost 3.x.
rdtools/normalization.py	Refactors datetime arithmetic to use total_seconds() and adds edge handling; adjusts interpolation/resolution behavior.
rdtools/soiling.py	Updates warnings stacklevel and adjusts numpy/pandas scalar/axis usage for newer versions.
rdtools/plotting.py	Adds stacklevel to experimental-warning emissions.
rdtools/degradation.py	Updates Timedelta strings to avoid pandas deprecation warnings.
rdtools/clearsky_temperature.py	Adds stacklevel to warnings.
rdtools/availability.py	Adds stacklevel to warnings.
rdtools/test/analysis_chains_test.py	Adjusts soiling expectations, disables clip filter for daily data tests, adds new clip frequency error test.
rdtools/test/normalization_pvwatts_test.py	Updates datetime calculations for pandas 3.x behavior.
rdtools/test/degradation_test.py	Updates Timedelta string casing.
docs/sphinx/source/changelog/v3.1.0.rst	Adds v3.1.0 changelog entry.
docs/sphinx/source/changelog.rst	Includes the new v3.1.0 changelog page.
docs/sphinx/source/api.rst	Removes deprecated normalization functions from API docs.
docs/notebook_requirements.txt	Updates notebook toolchain pins.
docs/nbval_sanitization_rules.cfg	Expands sanitization rules to accommodate stacklevel-related traceback diffs.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[martin-springer]

@mdeceglie - Copilot's review had a couple good suggestions that I added with this PR. It's ready for your review and merge.