Manifest-driven Bitcoin research software for YAML-defined experiments, benchmark artifacts, backtest ledgers, and decoder cohorts.
Project description
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.
- 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.
- Scaffold a starter manifest:
limen init logreg-first.yaml --template logreg_binary
- Validate, profile, and dry-run the manifest:
limen validate logreg-first.yaml
limen profile logreg-first.yaml
limen run --dry-run logreg-first.yaml
- Run it:
limen run logreg-first.yaml
- Inspect the result directory printed by the CLI:
- copied YAML manifest
metadata.jsonresults.csvround_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
- Start with the full docs hub at docs.vaquum.fi/limen
- Start with the YAML/CLI path in Command Line Interface and Experiment Manifest
- Use Universal Experiment Loop for the engine beneath CLI and direct Python integration
- Define extension research units in Single-File Decoder and Built-In SFDs
- Analyze results in Log, Benchmark, and Backtest
- Promote finished runs into reusable outputs with Trainer and Cohort
- Contribute through CONTRIBUTING.md and Developer docs
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
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file vaquum_limen-4.10.0.tar.gz.
File metadata
- Download URL: vaquum_limen-4.10.0.tar.gz
- Upload date:
- Size: 787.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
54c9219e0cc6c6814ef012de96398cfc13306e48fc382ea0db45feee8f9d4ee7
|
|
| MD5 |
f93b36bf08f4c82da40ef1167686a41f
|
|
| BLAKE2b-256 |
20297c8758e5e3b0e0511678ab333893cde26956d5894be96164ad92013bcbbd
|
Provenance
The following attestation bundles were made for vaquum_limen-4.10.0.tar.gz:
Publisher:
pr_publish_pypi.yml on Vaquum/Limen
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
vaquum_limen-4.10.0.tar.gz -
Subject digest:
54c9219e0cc6c6814ef012de96398cfc13306e48fc382ea0db45feee8f9d4ee7 - Sigstore transparency entry: 2163275799
- Sigstore integration time:
-
Permalink:
Vaquum/Limen@c40ba91eedefc8ec230fe755d1dabac5c03beb3c -
Branch / Tag:
refs/heads/main - Owner: https://github.com/Vaquum
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pr_publish_pypi.yml@c40ba91eedefc8ec230fe755d1dabac5c03beb3c -
Trigger Event:
workflow_run
-
Statement type:
File details
Details for the file vaquum_limen-4.10.0-py3-none-any.whl.
File metadata
- Download URL: vaquum_limen-4.10.0-py3-none-any.whl
- Upload date:
- Size: 694.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b36158b8a2b45aa6523d092bae5503e52f9dc73404bda9376dfb600ff9949751
|
|
| MD5 |
81c168ce4cf97c52acf1e4a27378cf15
|
|
| BLAKE2b-256 |
c8544797027e19be42f8b7d10bff1d8bdaddc21f0371b068721bc62f42d08336
|
Provenance
The following attestation bundles were made for vaquum_limen-4.10.0-py3-none-any.whl:
Publisher:
pr_publish_pypi.yml on Vaquum/Limen
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
vaquum_limen-4.10.0-py3-none-any.whl -
Subject digest:
b36158b8a2b45aa6523d092bae5503e52f9dc73404bda9376dfb600ff9949751 - Sigstore transparency entry: 2163275888
- Sigstore integration time:
-
Permalink:
Vaquum/Limen@c40ba91eedefc8ec230fe755d1dabac5c03beb3c -
Branch / Tag:
refs/heads/main - Owner: https://github.com/Vaquum
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pr_publish_pypi.yml@c40ba91eedefc8ec230fe755d1dabac5c03beb3c -
Trigger Event:
workflow_run
-
Statement type: