Skip to main content

Manifest-driven Bitcoin research software for YAML-defined experiments, benchmark artifacts, backtest ledgers, and decoder cohorts.

Project description


Vaquum

Vaquum Limen turns Bitcoin market data into searchable signals, backtested outcomes, and decoder cohorts.

OpenSSF practices badge OpenSSF Scorecard PyPI version Limen docs PR tests

Limen — Research engine

Manifest-driven Bitcoin alpha research engine that turns market data into searchable signals, backtested outcomes, and decoder cohorts.

Limen unifies parameter search across machine learning and rule-based strategies. Built-in analytics record benchmark, backtest, and cohort artifacts for inspection. The project evolves from Talos, a hyperparameter optimization framework for TensorFlow and Keras.

What Limen Is Not

Limen is not:

  • a trade execution system
  • a downstream trade decision engine
  • a generic multi-asset research platform

In the wider Vaquum architecture, Origo sits upstream as the data layer. Nexus, Praxis, and Veritas sit downstream for decisioning, execution, and oversight.

Capabilities

  • Manifest-driven experiment pipelines
  • Search across models, rules, features, targets, and hyperparameters
  • Built-in indicator and feature library for Bitcoin research
  • Support for both machine learning and rule-based strategy research
  • Bitcoin-native transforms, scaling, and target construction
  • Split-first train, validation, and test workflows
  • Built-in benchmark, backtest, and parameter diagnostics
  • Decoder cohort construction with pluggable selection
  • Reproducible runs with checkpointing, resumption, and retraining

First Experiment

The first runnable path is a YAML manifest executed through the limen CLI.

  1. Install the package:
pip install vaquum-limen

Supported runtime: Limen requires Python >=3.10,<3.14; package metadata advertises Python 3.10-3.13 on macOS and Linux. The default install is intentionally light. Use vaquum-limen[data] for Arrow dataset IO, vaquum-limen[boosting] for LightGBM/XGBoost models, vaquum-limen[indicators] for TA-Lib comparison tooling, vaquum-limen[stats] for statistical helpers, or vaquum-limen[all] for the full research stack. Security support covers the latest released Limen version through SECURITY.md.

  1. Scaffold a starter manifest:
limen init logreg-first.yaml --template logreg_binary
  1. Validate, profile, and dry-run the manifest:
limen validate logreg-first.yaml
limen profile logreg-first.yaml
limen run --dry-run logreg-first.yaml
  1. Run it:
limen run logreg-first.yaml
  1. Inspect the result directory printed by the CLI:
  • copied YAML manifest
  • metadata.json
  • results.csv
  • round_data.jsonl

That path runs the manifest-backed engine without Python orchestration code. The Python API remains available for custom SFDs, custom prep/model logic, and direct UEL integration.

Risk Boundary

Limen is research software. Benchmark and backtest outputs are not investment advice, trading advice, execution simulation, regulatory approval, or a promise of future performance. Past performance is not predictive, and trading digital assets can result in total loss of capital.

Learn more

Contributing

Contribution starts through CONTRIBUTING.md, docs changes, or open issues.

Before contributing, start with the Developer docs.

Support

Use SUPPORT.md for support routes and scope boundaries.

Vulnerabilities

Report vulnerabilities privately through GitHub Security Advisories. Do not report vulnerabilities through public issues.

Citations

Published work should cite:

Vaquum Limen [Computer software]. (2026). Retrieved from https://github.com/Vaquum/Limen.

Machine-readable citation metadata lives in CITATION.cff.

License

MIT License.

Project details


Release history Release notifications | RSS feed

This version

4.6.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vaquum_limen-4.6.0.tar.gz (782.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vaquum_limen-4.6.0-py3-none-any.whl (689.0 kB view details)

Uploaded Python 3

File details

Details for the file vaquum_limen-4.6.0.tar.gz.

File metadata

  • Download URL: vaquum_limen-4.6.0.tar.gz
  • Upload date:
  • Size: 782.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for vaquum_limen-4.6.0.tar.gz
Algorithm Hash digest
SHA256 66fe4f9e44bf883847b723086a8a58b4fa949dd8bbe2e6c0f5a0e5050b257d81
MD5 6b056d595c20e7851b4dedae7f434f74
BLAKE2b-256 182b7e8ef766f5640d49b492feacb2b2769100bff9defc578388dc65bc217963

See more details on using hashes here.

Provenance

The following attestation bundles were made for vaquum_limen-4.6.0.tar.gz:

Publisher: pr_publish_pypi.yml on Vaquum/Limen

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file vaquum_limen-4.6.0-py3-none-any.whl.

File metadata

  • Download URL: vaquum_limen-4.6.0-py3-none-any.whl
  • Upload date:
  • Size: 689.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for vaquum_limen-4.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e6c6f14f227f289ba5b0c1031e5c45cf98204c3b3d449be7bd9a6c6d8a787ac7
MD5 3a77d02366d6e61deb9283328e0b9c10
BLAKE2b-256 7d04b8a013207b08d0df698f09ce4fe2b3e6687d5d87df913dd98f4478b6e2e3

See more details on using hashes here.

Provenance

The following attestation bundles were made for vaquum_limen-4.6.0-py3-none-any.whl:

Publisher: pr_publish_pypi.yml on Vaquum/Limen

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page