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
  • Perturbation-based robustness search across feature groups, scalers, and ablation
  • 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 validated round replay

First Experiment

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

  1. Install the package:
pip install "vaquum-limen[data]"

Supported runtime: Limen requires Python >=3.10,<3.14; package metadata advertises Python 3.10-3.13 on macOS and Linux. The first experiment reads Arrow data, so it needs the data extra. The default install is intentionally light for API surfaces that do not load data. Use 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 GitHub.

Machine-readable citation metadata lives in CITATION.cff.

License

MIT License.

Project details


Release history Release notifications | RSS feed

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-5.9.5.tar.gz (1.2 MB view details)

Uploaded Source

Built Distribution

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

vaquum_limen-5.9.5-py3-none-any.whl (752.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for vaquum_limen-5.9.5.tar.gz
Algorithm Hash digest
SHA256 238104b72e0c0674e30362e1dc508b73ff126172b2133fcc6bff6724210e89a7
MD5 3ae0ef3287136719a27849b953b7ee66
BLAKE2b-256 6653d44e6394137ac3e44a63842f1cb18526adc90780ff8627ec3dddd355037b

See more details on using hashes here.

Provenance

The following attestation bundles were made for vaquum_limen-5.9.5.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-5.9.5-py3-none-any.whl.

File metadata

  • Download URL: vaquum_limen-5.9.5-py3-none-any.whl
  • Upload date:
  • Size: 752.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-5.9.5-py3-none-any.whl
Algorithm Hash digest
SHA256 97a01e915fd7ce33ab51db9cd8a9e4edcc21e897e493e359aec6e7cf2fc955bf
MD5 e577381fc001ba57795cf1f8a5ba5d3b
BLAKE2b-256 2f6ceb3abe0e4e3633fac8c677d84ea17cbaed858578201bd19bcc9775561b92

See more details on using hashes here.

Provenance

The following attestation bundles were made for vaquum_limen-5.9.5-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