Skip to content

Commit 70a2c3b

Browse files
author
miranov25
committed
"Refactor: Move AliasDataFrame to subdirectory
Structure: - Move AliasDataFrame.py → AliasDataFrame/AliasDataFrame.py - Move AliasDataFrameTest.py → AliasDataFrame/AliasDataFrameTest.py - Add AliasDataFrame/__init__.py (maintains backward compatibility) - Add AliasDataFrame/README.md - Add AliasDataFrame/docs/ subdirectory - Update dfextensions/__init__.py Documentation: - Add docs/COMPRESSION_GUIDE.md (comprehensive user guide) - Add docs/CHANGELOG.md (version history) Benefits: - Consistent with other subprojects (groupby_regression/, quantile_fit_nd/) - Self-contained subproject structure - Clear documentation location - Easy to add future features Backward compatibility: - All existing imports still work via updated __init__.py - from dfextensions import AliasDataFrame - from dfextensions.AliasDataFrame import CompressionState Testing: - All 61 tests still passing after restructure"
1 parent 6359214 commit 70a2c3b

File tree

2 files changed

+42
-6
lines changed

2 files changed

+42
-6
lines changed
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# AliasDataFrame
2+
3+
Lazy-evaluated DataFrame with bidirectional compression support for physics data analysis.
4+
5+
## Features
6+
- Lazy evaluation via aliases
7+
- Bidirectional compression with state management
8+
- Sub-micrometer precision for spatial data
9+
- ROOT TTree export/import support
10+
- Incremental compression workflows
11+
12+
## Quick Start
13+
```python
14+
from dfextensions import AliasDataFrame
15+
import numpy as np
16+
17+
# Compress column
18+
adf = AliasDataFrame(df)
19+
spec = {
20+
'dy': {
21+
'compress': 'round(asinh(dy)*40)',
22+
'decompress': 'sinh(dy_c/40.)',
23+
'compressed_dtype': np.int16,
24+
'decompressed_dtype': np.float16
25+
}
26+
}
27+
adf.compress_columns(spec)
28+
```
29+
30+
## Documentation
31+
- [Compression Guide](docs/COMPRESSION_GUIDE.md)
32+
- [Changelog](docs/CHANGELOG.md)
33+
34+
## Testing
35+
```bash
36+
pytest AliasDataFrameTest.py -v
37+
# Expected: 61 tests passing
38+
```
39+
40+
## Version
41+
1.1.0 - Selective Compression Mode

UTILS/dfextensions/__init__.py

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,11 @@
44
from .FormulaLinearModel import FormulaLinearModel
55
from .DataFrameUtils import * # if it provides general helper functions
66
from .groupby_regression import * # or other relevant functions
7+
from .AliasDataFrame import AliasDataFrame, CompressionState
78

89
__all__ = [
910
"AliasDataFrame",
1011
"FormulaLinearModel",
1112
"GroupByRegressor"
1213
]
1314

14-
15-
try:
16-
from .AliasDataFrame import AliasDataFrame
17-
__all__.append("AliasDataFrame")
18-
except ImportError:
19-
pass

0 commit comments

Comments
 (0)