Metadata-Version: 2.4
Name: helixio
Version: 0.1.3
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Rust
Classifier: Topic :: Office/Business :: Financial
Requires-Dist: polars>=1.41.2
Requires-Dist: polars>=1.0 ; extra == 'frames'
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: quantlib>=1.42.1 ; extra == 'test'
Requires-Dist: polars>=1.0 ; extra == 'test'
Provides-Extra: frames
Provides-Extra: test
License-File: LICENSE.md
Summary: Reverse-mode-AD fixed-income library: calendars, day-counts, curves, cashflows, instruments, valuation.
Author-email: "helixio.xyz" <info@helixio.xyz>
License: MIT
Requires-Python: >=3.11
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: Issues, https://github.com/helixio-xyz/helixio/issues
Project-URL: Repository, https://github.com/helixio-xyz/helixio

# helixio

A reverse-mode-AD fixed-income library, rewritten from scratch as two separated
packages in one Cargo workspace:

- **`helixrs`** (`crates/helixrs/`) — the pure-Rust core: calendars, day counts,
  conventions, market context, curves, cashflows, instruments, pricing models,
  positions, and scenarios. Every numeric value is `AReal = xad_rs::AReal<f64>`
  (reverse-mode AD; there is no `f64` monomorph).
- **`helixio`** (`python/helixio/`, built from `crates/helixio/`) — the Python
  distribution: a thin PyO3 binding (`helixio._core`) plus an idiomatic Python
  surface.
  

This repository currently holds the **workspace scaffold** only — the module tree
is declared but empty. Domain logic is ported in subsequent from-scratch changes
(see `openspec/changes/`).

## Build

```bash
# Rust core + binding
cargo build

# Python wheel (into the active venv)
maturin develop
python -c "import helixio; print(helixio.version())"
```

## Layout

```
crates/helixrs/      Rust library (the core substrate)
crates/helixio/      PyO3 cdylib  -> helixio._core
python/helixio/      Python package (re-exports + ergonomics)
```

## License

MIT. See `LICENSE.md`.

