This issue tracks the comprehensive refactoring of the repository structure for Version 2. The key objectives are:
- Rename the root module to
fluctuation_analysis_tools for better clarity
- Introduce an
experimental submodule for new features under development
- Create a
legacy submodule ensuring backward compatibility with v1.*
Proposed Changes
Repository Structure
fluctuation-analysis-tools/
├── fluctuation_analysis_tools/ # Root module (renamed)
│ ├── analysis/ # Core analysis functions
│ ├── generators/ # Data generation tools
│ ├── filters/ # Filtering utilities
│ ├── visualization/ # Visualization tools
│ ├── auxiliary/ # Helper functions
│ ├── experimental/ # New features (unstable)
│ └── legacy/ # v1.* compatibility layer
├── setup.py
└── pyproject.toml
Key Features
- Experimental Submodule: Isolated workspace for new features with clear opt-in usage
- Legacy Submodule: Maintains v1.* API via
from fluctuation_analysis_tools.legacy import StatTools
- Improved Organization: Logical grouping of related functionality
Implementation Plan
- Rename root module from
StatTools to fluctuation_analysis_tools
- Restructure code into logical submodules
- Create legacy compatibility layer
- Update all documentation and configuration files
- Comprehensive testing of migration path
Testing Requirements
- Verify backward compatibility through legacy submodule
- Test experimental features in isolation
- Confirm all existing functionality remains intact
This issue tracks the comprehensive refactoring of the repository structure for Version 2. The key objectives are:
fluctuation_analysis_toolsfor better clarityexperimentalsubmodule for new features under developmentlegacysubmodule ensuring backward compatibility with v1.*Proposed Changes
Repository Structure
Key Features
from fluctuation_analysis_tools.legacy import StatToolsImplementation Plan
StatToolstofluctuation_analysis_toolsTesting Requirements