Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
reduced min scipy req to 1.10 (#178)
## Description This pull request updates the `pyproject.toml` configuration by lowering the minimum required version of `scipy` from `1.13` to `1.10`. This change addresses an `ImportError` encountered by users attempting to import `MovingBlockBootstrap` from the `tsbootstrap` library when using `scipy` versions `1.13` and above. Specifically, the error: `ImportError: cannot import name 'gaussian' from 'scipy.signal'` occurs because the `gaussian` function was removed or relocated in newer versions of `scipy`. By allowing `scipy>=1.10`, this PR ensures compatibility with versions that still include the necessary `gaussian` function, thereby resolving the import issue without sacrificing existing functionality. **Issue Addressed:** A user reported that importing `MovingBlockBootstrap` results in an `ImportError` due to incompatibility with `scipy` versions `>=1.13`. Downgrading to `scipy` `1.10` resolves the error, but the package's current `pyproject.toml` restricts `scipy` to `>=1.13`, preventing this workaround. ## Type of change - [x] Bug fix (non-breaking change which fixes an issue) ## How Has This Been Tested? The changes were tested through the following steps: 1. **Environment Setup:** - Created a virtual environment with `scipy` version `1.10.0`. - Installed the updated version of `tsbootstrap` from the current branch. 2. **Import Verification:** - Successfully imported `MovingBlockBootstrap` without encountering the `ImportError`. ```python from tsbootstrap import MovingBlockBootstrap ``` 3. **Functionality Testing:** - Ran existing unit tests to ensure all functionalities of `tsbootstrap` operate as expected with `scipy` `1.10.0`. - Verified that no new warnings or errors are introduced during package usage. 4. **Compatibility Check:** - Ensured that the package remains compatible with `scipy` versions `>=1.10` and `<1.14.0` as specified. ## Checklist: - [x] My code follows the style guidelines of this project - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas (if applicable) - [x] I have made corresponding changes to the documentation (if applicable) - [x] My changes generate no new warnings - [x] Any dependent changes have been merged and published in downstream modules (if applicable) ## Additional Information (if applicable) - **Reason for Version Downgrade:** The `gaussian` function required by `tsbootstrap` was removed or altered in `scipy` versions `>=1.13`, causing the import error. Downgrading to `scipy` `1.10` reinstates the necessary functionality. - **Potential Impact:** Users relying on `scipy` versions `>=1.13` will need to use `scipy` `<1.14.0` to maintain compatibility with `tsbootstrap`. This adjustment broadens the range of compatible `scipy` versions, allowing more flexibility for users who may need to use older versions. Co-authored-by: Sankalp Gilda <[email protected]>
- Loading branch information