Skip to content

Commit 580defb

Browse files
committed
created a changelog file and updated readme w.r.t. GOES instrumtent loader
1 parent bf1a0a0 commit 580defb

File tree

2 files changed

+94
-2
lines changed

2 files changed

+94
-2
lines changed

CHANGELOG.md

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
6+
## [Unreleased]
7+
8+
## [1.0.1b] - 2025-08-15
9+
10+
### Added
11+
12+
#### Instrument Support
13+
- Support for GOES-ABI instrument alongside MSG-SEVIRI
14+
- New `load_goes_abi()` method for GOES-ABI configuration with 16 spectral channels
15+
- Generic `load_instrument()` method for instrument-agnostic loading
16+
17+
#### Code Structure and Organization
18+
- Parametrized tests for both SEVIRI and ABI instruments using pytest
19+
- Test utilities for loading predefined atmospheric profiles
20+
- Comprehensive test coverage for different channel configurations
21+
- Bash script for running both unit tests and Jupyter notebook execution
22+
23+
#### Data Handling
24+
- Enhanced error handling with specific exception types (e.g., `KeyError`, `FileNotFoundError`)
25+
- Improved filename pattern matching and sorting for data processing
26+
- Support for symbolic link creation for data management
27+
28+
#### Documentation
29+
- NumPy-style docstrings throughout the codebase
30+
- Enhanced API documentation structure
31+
- Improved function parameter documentation
32+
33+
### Changed
34+
35+
#### Instrument Configuration
36+
- Refactored instrument loading with case-insensitive instrument selection
37+
- Renamed variables from `chan_list_seviri`/`nchan_seviri` to generic `chan_list_instrument`/`nchan_instrument`
38+
- Renamed `load_seviri()` to `load_msg_seviri()` for consistency
39+
- Updated instrument attribute naming for better clarity
40+
41+
#### Code Quality
42+
- Replaced bare `except` clauses with specific exception handling
43+
- Improved code modularity and separation of concerns
44+
- Enhanced variable naming conventions for better readability
45+
46+
#### Testing Infrastructure
47+
- Improved test script with sorted output and hidden path exclusion
48+
- Enhanced workflow testing for multiple instruments
49+
- Better test organization and parameterization
50+
51+
### Fixed
52+
53+
#### File Processing
54+
- File path handling in test scripts and data processing
55+
- Channel list sorting in workflow execution
56+
- Hidden file/directory exclusion in file search operations
57+
58+
#### Data Processing
59+
- Pressure calculation and coordinate handling in ERA data processing
60+
- Specific humidity clipping with configurable minimum values
61+
- Time coordinate selection and merging in multi-dimensional datasets
62+
63+
### Technical Details
64+
65+
#### Dependencies
66+
- Maintains compatibility with existing pyrttov, xarray, and numpy dependencies
67+
- Added support for pytest parameterization features
68+
- Enhanced Jupyter notebook execution capabilities
69+
70+
#### Performance
71+
- Optimized file searching with improved find commands
72+
- Better memory management in chunked data processing
73+
- Streamlined instrument loading procedures
74+
75+
## [1.0.0] - 2024-04-16
76+
77+
### Added
78+
- Initial release of SynSatiPy
79+
- MSG-SEVIRI instrument support for satellite radiance simulation
80+
- ERA5 and ICON model data input support
81+
- RTTOV integration for radiative transfer calculations
82+
- Basic test framework and example notebooks
83+
- Documentation structure and API reference
84+
85+
### Dependencies
86+
- pyrttov for radiative transfer calculations
87+
- xarray for multi-dimensional data handling
88+
- numpy for numerical operations
89+
- netCDF4 for data I/O

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ SynSatiPy is a Python interface to the RTTOV software that helps to input model
1616

1717
Currently, the SynSatiPy interface
1818
- supports the following RTTOV versions: v13.1 and v13.2.
19-
- provides interfaces to the following satellite sensors: SEVIRI
19+
- provides interfaces to the following satellite sensors: MSG-SEVIRI and GOES-ABI
2020
- is tested with python 3.10 or higher
2121

2222

@@ -42,9 +42,12 @@ Further documentation is provided here: https://synsatipy.readthedocs.io.
4242

4343
## Contributing
4444
Please feel invited to contributed to the SynSatiPy python package (via pull requests). Possible extension are (not exclusive):
45-
- implementation of further satellite sensor interfaces
45+
- implementation of further satellite sensor interfaces (currently supports MSG-SEVIRI and GOES-ABI)
4646
- implementation of further model input interfaces
4747

4848
Please provide bug reports or ideas for extensions as issues!
4949

50+
## Recent Updates
51+
For detailed information about recent changes and updates, see the [CHANGELOG.md](CHANGELOG.md).
52+
5053

0 commit comments

Comments
 (0)