OOP interface for SUEWS output and forcing data #925
+1,921
−47
Conversation
This file contains hidden or 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
|
🤖 I've automatically formatted the code in this PR using:
Please pull the latest changes before making further edits. |
sunt05
force-pushed
the
sunt05/oop-output-forcing
branch
2 times, most recently
from
a50409d to
5a5bc59
Compare
- Add SUEWSForcing and SUEWSOutput classes for object-oriented data handling - Update SUEWSSimulation.run() to return SUEWSOutput instead of DataFrame - Add from_output() classmethod for continuation runs - Update forcing property to return SUEWSForcing wrapper - Update tests to use new OOP interfaces
Co-authored-by: sunt05 <1802656+sunt05@users.noreply.github.com>
Add missing pandas-like properties to SUEWSForcing and SUEWSOutput classes to ensure compatibility with existing test code: SUEWSForcing: - index: DatetimeIndex access - loc: Label-based indexer - iloc: Integer-based indexer SUEWSOutput: - empty: Check if output is empty - columns: Column index access - loc/iloc: Indexers for data access - xs(): Cross-section method for MultiIndex - Updated __getattr__ to check group names 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Add deprecation warnings to methods superseded by pandas-compatible properties: SUEWSForcing: - times -> use .index - n_timesteps -> use len(forcing) - to_dataframe() -> use .df SUEWSOutput: - n_grids -> use len(output.grids) - n_timesteps -> use len(output.times) - to_dataframe() -> use .df All deprecated methods still work but emit DeprecationWarning to guide users towards the preferred pandas-like API. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
- Add deprecation warning to util.read_forcing() pointing users to SUEWSForcing.from_file() - Extract internal _read_forcing_impl() for use by SUEWSForcing without triggering deprecation warnings - Update SUEWSForcing.from_file/from_files to use internal function This completes the deprecation of the functional API in favour of the modern OOP interface. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
sunt05
force-pushed
the
sunt05/oop-output-forcing
branch
from
5a5bc59 to
a58c352
Compare
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.
Summary
Implements object-oriented interfaces for SUEWS output and forcing data, improving the simulation API ergonomics.
Changes
SUEWSForcingclass for meteorological input with validation, analysis, and manipulation methodsSUEWSOutputclass for simulation results with analysis and export capabilitiesSUEWSSimulation.run()to returnSUEWSOutputinstead of raw DataFrameSUEWSSimulation.from_output()for seamless continuation runsDesign
Both classes provide intuitive attribute access (e.g.,
forcing.temperature), alongside professional APIs with full documentation. Methods follow pandas conventions for familiar usage.