Metadata-Version: 2.4
Name: pmtvs-embedding
Version: 0.3.3
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Rust
Classifier: Topic :: Scientific/Engineering
Requires-Dist: numpy>=1.20
Requires-Dist: pytest>=7.0 ; extra == 'dev'
Requires-Dist: pytest-benchmark>=4.0 ; extra == 'dev'
Provides-Extra: dev
Summary: Time-delay embedding for dynamical systems analysis (4 functions, 1 Rust-accelerated)
Author: pmtvs contributors
License: PolyForm-Strict-1.0.0
Requires-Python: >=3.9
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: Homepage, https://github.com/pmtvs/pmtvs
Project-URL: Repository, https://github.com/pmtvs/pmtvs

# pmtvs-embedding

Time-delay embedding for dynamical systems analysis.

## Installation

```bash
pip install pmtvs-embedding
```

## Functions

- `delay_embedding(signal, dim, tau)` - Construct time-delay embedding matrix
- `optimal_embedding_dimension(signal, tau, max_dim, threshold)` - Cao's method
- `mutual_information_delay(signal, max_lag, n_bins)` - Find optimal delay
- `false_nearest_neighbors(signal, tau, max_dim)` - FNN method

## Rust Acceleration

1 of 4 functions has Rust implementation (~12x speedup for delay_embedding).
Disable with `PMTVS_USE_RUST=0`.

## License

PolyForm Strict 1.0.0 with Additional Terms.

- **Students & individual researchers:** Free. Cite us.
- **Funded research labs (grants > $100K):** Academic Research License required. [Contact us](mailto:licensing@pmtvs.dev).
- **Commercial use:** Commercial License required. [Contact us](mailto:licensing@pmtvs.dev).

See [LICENSE](LICENSE) for full terms.

