Code Quality Improvements and Enhanced Hazus Usability #39
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
Relax validation constraints for seismic and flood assessments to improve usability while maintaining analysis accuracy: - Allow HeightClass attribute for seismic structural systems (W1, W2, S3, PC1, MH) that don't require it in Hazus methodology - Remove PlanArea field from auto-populated seismic configuration as it's no longer needed - Allow RES1 occupancy buildings to have more than 3 stories in flood assessments, aligning with FEMA technical manual interpretation These changes provide users more flexibility in input specification while ensuring unused attributes don't affect analysis results.
This commit addresses code quality issues identified by ruff format, ruff check, and codespell tools across the entire codebase. The changes maintain existing functionality while improving code consistency, readability, and adherence to Python best practices. ## Changes Made: ### Code Formatting and Linting (ruff format & ruff check) - Applied consistent code formatting across 15 Python files - Fixed docstring formatting and missing docstring issues (D100, D211, D212) - Cleaned up import statements and unused code - Standardized quote usage and line spacing ### Configuration Updates - Updated `pyproject.toml` to include additional ruff ignore rules (PLR2004, D100) - Updated `.gitignore` for better file exclusion patterns ## Testing: All changes have been validated to ensure: - Code passes ruff format checks - Code passes ruff linting rules - Spelling issues resolved via codespell - No breaking changes to existing functionality
This commit updates all documentation files in preparation for the v2.1.0 release: - Add comprehensive v2.1.0 release notes (doc/source/release_notes/v2.1.0.rst) detailing code quality improvements and enhanced Hazus assessment usability - Update README.md to reference v2.1.0 and highlight improvements over v2.0.0 - Add v2.1.0 section to CHANGELOG.md with detailed breakdown of changes and fixes All documentation follows established formatting conventions and maintains consistency with previous release documentation structure.
This commit updates all documentation files in preparation for the v2.1.0 release: - Add comprehensive v2.1.0 release notes (doc/source/release_notes/v2.1.0.rst) detailing code quality improvements and enhanced Hazus assessment usability - Update README.md to reference v2.1.0 and highlight improvements over v2.0.0 - Add v2.1.0 section to CHANGELOG.md with detailed breakdown of changes and fixes All documentation follows established formatting conventions and maintains consistency with previous release documentation structure.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Code Quality Improvements and Enhanced Hazus Usability
Overview
This pull request introduces v2.1.0 of the Damage and Loss Model Library, focusing on code quality enhancements and improved usability for Hazus assessments while maintaining full backward compatibility.
Key Changes
Code Quality Improvements
Enhanced Hazus Assessment Usability
Documentation Updates