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
  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, or a promise of future performance.

Learn more

Contributing

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

Before contributing, start with docs/Developer/README.md.

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

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-3.31.1.tar.gz (683.0 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-3.31.1-py3-none-any.whl (633.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for vaquum_limen-3.31.1.tar.gz
Algorithm Hash digest
SHA256 60e962aef46779ee0bf491416a10e04adad48c96a5e8803d4e5eb0cffd10dfc0
MD5 20401bf591ed7dadb96c991e3115bde2
BLAKE2b-256 fdbc02b9cc2ba31441e5f8b56b36d8074c5ef49b41a8371e6f5f6b176de4562b

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: vaquum_limen-3.31.1-py3-none-any.whl
  • Upload date:
  • Size: 633.6 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-3.31.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c806aaf7c8c900d3d9ef778e976baffd739d7a08662f154bb61327647ad4c764
MD5 e5dc9f65592bc969379173a32e720375
BLAKE2b-256 3d3f4531a5305fbfb943916196211a8f34c6f3a9998678ee6bb1df7b5cae3c8c

See more details on using hashes here.

Provenance

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