libxrk 0.6.0__cp313-cp313-macosx_11_0_arm64.whl

libxrk-0.6.0.dist-info/METADATA

@@ -0,0 +1,234 @@
+Metadata-Version: 2.4
+Name: libxrk
+Version: 0.6.0
+Summary: Library for reading AIM XRK files from AIM automotive data loggers
+License-File: LICENSE
+Author: Christopher Dewan
+Author-email: chris.dewan@m3rlin.net
+Requires-Python: >=3.10
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Cython
+Classifier: Topic :: Scientific/Engineering
+Provides-Extra: dev
+Provides-Extra: test
+Requires-Dist: cython (>=3.0.0)
+Requires-Dist: numpy (>=1.26.0) ; python_version < "3.14"
+Requires-Dist: numpy (>=2.4.0) ; python_version >= "3.14"
+Requires-Dist: parameterized (>=0.9.0) ; extra == "dev"
+Requires-Dist: parameterized (>=0.9.0) ; extra == "test"
+Requires-Dist: pyarrow (>=18.1.0) ; python_version < "3.14"
+Requires-Dist: pyarrow (>=22.0.0) ; python_version >= "3.14"
+Requires-Dist: pytest (>=7.0.0) ; extra == "dev"
+Requires-Dist: pytest (>=7.0.0) ; extra == "test"
+Requires-Dist: setuptools (>=68.0.0) ; extra == "dev"
+Project-URL: Homepage, https://github.com/m3rlin45/libxrk
+Project-URL: Issues, https://github.com/m3rlin45/libxrk/issues
+Project-URL: Repository, https://github.com/m3rlin45/libxrk
+Description-Content-Type: text/markdown
+
+# libxrk
+
+A Python library for reading AIM XRK and XRZ files from AIM automotive data loggers.
+
+## Features
+
+- Read AIM XRK files (raw data logs)
+- Read AIM XRZ files (zlib-compressed XRK files)
+- Parse track data and telemetry channels
+- GPS coordinate conversion and lap detection
+- High-performance Cython implementation
+- Supports Python 3.10 - 3.14
+
+## Installation
+
+### Install from PyPI
+
+```bash
+pip install libxrk
+```
+
+### Install from Source
+
+#### Prerequisites
+
+On Ubuntu/Debian:
+```bash
+sudo apt install build-essential python3-dev
+```
+
+#### Install with Poetry
+
+```bash
+poetry install
+```
+
+The Cython extension will be automatically compiled during installation.
+
+## Usage
+
+```python
+from libxrk import aim_xrk
+
+# Read an XRK file
+log = aim_xrk('path/to/file.xrk')
+
+# Read an XRZ file (automatically decompressed)
+log = aim_xrk('path/to/file.xrz')
+
+# Access channels (each channel is a PyArrow table with 'timecodes' and value columns)
+for channel_name, channel_table in log.channels.items():
+    print(f"{channel_name}: {channel_table.num_rows} samples")
+
+# Get all channels merged into a single PyArrow table
+# (handles different sample rates with interpolation/forward-fill)
+merged_table = log.get_channels_as_table()
+print(merged_table.column_names)
+
+# Convert to pandas DataFrame
+df = merged_table.to_pandas()
+
+# Access laps (PyArrow table with 'num', 'start_time', 'end_time' columns)
+print(f"Laps: {log.laps.num_rows}")
+for i in range(log.laps.num_rows):
+    lap_num = log.laps.column("num")[i].as_py()
+    start = log.laps.column("start_time")[i].as_py()
+    end = log.laps.column("end_time")[i].as_py()
+    print(f"Lap {lap_num}: {start} - {end}")
+
+# Access metadata
+print(log.metadata)
+```
+
+### Filtering and Resampling
+
+```python
+from libxrk import aim_xrk
+
+log = aim_xrk('session.xrk')
+
+# Select specific channels
+gps_log = log.select_channels(['GPS Latitude', 'GPS Longitude', 'GPS Speed'])
+
+# Filter to a time range (milliseconds, inclusive start, exclusive end)
+segment = log.filter_by_time_range(60000, 120000)
+
+# Filter to a specific lap
+lap5 = log.filter_by_lap(5)
+
+# Combine filtering and channel selection
+lap5_gps = log.filter_by_lap(5, channel_names=['GPS Latitude', 'GPS Longitude'])
+
+# Resample all channels to match a reference channel's timebase
+aligned = log.resample_to_channel('GPS Speed')
+
+# Resample to a custom timebase
+import pyarrow as pa
+target = pa.array(range(0, 100000, 100), type=pa.int64())  # 10 Hz
+resampled = log.resample_to_timecodes(target)
+
+# Chain operations for analysis workflows
+df = (log
+    .filter_by_lap(5)
+    .select_channels(['Engine RPM', 'GPS Speed'])
+    .resample_to_channel('GPS Speed')
+    .get_channels_as_table()
+    .to_pandas())
+```
+
+All filtering and resampling methods return new `LogFile` instances (immutable pattern), enabling method chaining for complex analysis workflows.
+
+## Development
+
+### Quick Check
+```bash
+# Run all quality checks (format check, type check, tests)
+poetry run poe check
+```
+
+### Code Formatting
+
+This project uses [Black](https://black.readthedocs.io/) for code formatting.
+
+```bash
+# Format all Python files
+poetry run black .
+```
+
+### Type Checking
+
+This project uses [mypy](https://mypy.readthedocs.io/) for static type checking.
+
+```bash
+# Run type checker on all Python files
+poetry run mypy .
+```
+
+### Running Tests
+
+This project uses [pytest](https://pytest.org/) for testing.
+
+```bash
+# Run all tests
+poetry run pytest
+
+# Run tests with verbose output
+poetry run pytest -v
+
+# Run specific test file
+poetry run pytest tests/test_xrk_loading.py
+
+# Run tests with coverage
+poetry run pytest --cov=libxrk
+```
+
+### Testing with Pyodide (WebAssembly)
+
+You can test the library in a WebAssembly environment using Pyodide.
+This requires Node.js to be installed.
+
+```bash
+# Build and run tests in Pyodide (installs Emscripten SDK to build/emsdk if needed)
+poetry run poe pyodide-test
+```
+
+Note: Pyodide tests run automatically in CI via GitHub Actions.
+
+### Building
+
+```bash
+# Build CPython wheel and sdist
+poetry build
+
+# Build all wheels (CPython, Pyodide/WebAssembly, and sdist)
+poetry run poe build-all
+```
+
+### Clean Build
+
+```bash
+# Clean all build artifacts and rebuild
+rm -rf build/ dist/ src/libxrk/*.so && poetry install
+```
+
+## Testing
+
+The project includes end-to-end tests that validate XRK and XRZ file loading and parsing.
+
+Test files are located in `tests/test_data/` and include real XRK and XRZ files for validation.
+
+## Credits
+
+This project incorporates code from [TrackDataAnalysis](https://github.com/racer-coder/TrackDataAnalysis) by Scott Smith, used under the MIT License.
+
+## License
+
+MIT License - See LICENSE file for details.
+

libxrk-0.6.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+libxrk/gps.py,sha256=WAkYXPdWA4-ETWuzTvYqU8ig0l4pm3MSoRaNz2qrvNQ,17030
+libxrk/aim_xrk.pyx,sha256=hkC1nIBdkxBIkqCMVHvHUEB9nObP0SVhM2QX-oKOVC4,37573
+libxrk/__init__.py,sha256=TZA05GTnBHlxZt0qY3U1lVrbOCMwfUy2A_VIAu9bk0U,848
+libxrk/aim_xrk.pyi,sha256=rvM4jREIdPmK_pWtAI024V8TFNJx1XDGqhBL6Jb1pQo,1159
+libxrk/aim_xrk.cpython-313-darwin.so,sha256=cOJM6jqvvKJ_iCGnzQ8U_YYZdYnXJu9SZa1O6ApoSaY,533712
+libxrk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+libxrk/base.py,sha256=Qz8i066END2bcGjxblKufqNT-MOHJGjQnwKFP9kXnI8,12875
+libxrk/CLAUDE.md,sha256=bzhPZ6H2nOCHL18irkszle7A-0n5za9MkJVO_s8uC7U,2514
+libxrk-0.6.0.dist-info/RECORD,,
+libxrk-0.6.0.dist-info/WHEEL,sha256=DeuNubWKbjO7iFLfcVskJLr2HMK4oKpW3Lf9Trm124s,134
+libxrk-0.6.0.dist-info/METADATA,sha256=E0So3sn_v8_zCD1brhKsIKLOC4FYRbhH9TRF7Ia6PGM,6227
+libxrk-0.6.0.dist-info/licenses/LICENSE,sha256=ID2HgxccQxGGWfIuuyrbNRych2luvUpWqF6Vt1aNWAk,1154

libxrk-0.6.0.dist-info/WHEEL

@@ -0,0 +1,6 @@
+Wheel-Version: 1.0
+Generator: poetry-core 2.3.0
+Root-Is-Purelib: false
+Tag: cp313-cp313-macosx_11_0_arm64
+Generator: delocate 0.13.0
+

libxrk-0.6.0.dist-info/licenses/LICENSE

@@ -0,0 +1,25 @@
+MIT License
+
+(For components copied from TrackDataAnalysis)
+Copyright (c) 2024 Scott Smith
+
+Copyright (c) 2025 Christopher Dewan
+
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.