Bitcoin-first research and trading platform.
Project description
Limen — The 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, with built-in analytics that show not just what works, but why it works. It evolves from Talos, the hyperparameter optimization framework for TensorFlow and Keras cited in over 1,000 scientific papers with zero breaking bugs in six years.
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
- Extensive 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
- Leakage-safe train, validation, and test workflows
- Built-in backtesting, confusion analytics, and parameter diagnostics
- Decoder cohort construction and regime-diversified model pooling
- Reproducible runs with checkpointing, resumption, and retraining
First Experiment
The fastest first success is a small parameter sweep on the bundled BTC/USDT kline dataset with the built-in logistic-regression decoder.
- Install the package:
pip install vaquum_limen
- Load data and run a first experiment:
import limen
historical = limen.HistoricalData()
data = historical.get_spot_klines(kline_size=7200, n_rows=2000)
uel = limen.UniversalExperimentLoop(data=data, sfd=limen.sfd.logreg_binary)
uel.run(
experiment_name="logreg-first",
n_permutations=25,
prep_each_round=True,
)
- Inspect the core outputs:
uel.experiment_logfor the parameter sweep resultsuel.experiment_confusion_metricsfor confusion analyticsuel.experiment_backtest_resultsfor backtest results
That path is the simplest way to get a real Limen run on your machine without relying on repo-local fixture files. If you want richer run directories, checkpoints, resumability, and stored round artefacts, continue into the UEL documentation below.
Learn More
- Start with the full docs hub in docs/README.md
- Define research units in docs/Single-File-Decoder.md, docs/Built-In-SFDs.md, and docs/Experiment-Manifest.md
- Run experiments in docs/Universal-Experiment-Loop.md and extend the artifact-rich path through docs/Advanced-Search.md and docs/Reducers-And-Feedback.md
- Analyze results in docs/Log.md, docs/Benchmark.md, and docs/Backtest.md
- Understand the model layer in docs/Reference-Architecture.md and the helper layer in docs/Utilities.md
- Promote finished runs into reusable outputs with docs/Trainer.md and docs/Regime-Diversified-Opinion-Pools.md
- Contribute through docs/Developer/README.md
Contributing
The simplest way to start contributing is by joining an open discussion, contributing to the docs, or by picking up an open issue.
Before contributing, start with docs/Developer/README.md.
Vulnerabilities
Report vulnerabilities privately through GitHub Security Advisories.
Citations
If you use Limen for published work, please cite:
Vaquum Limen [Computer software]. (2026). Retrieved from https://github.com/Vaquum/Limen.
License
Project details
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-2.5.6.tar.gz.
File metadata
- Download URL: vaquum_limen-2.5.6.tar.gz
- Upload date:
- Size: 269.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
414b3a90e23bbc694cb26ce9c6c05583c360745cafb01bda31b83f622ce72dc4
|
|
| MD5 |
a3d6b76d535823a20515f0cb38b78462
|
|
| BLAKE2b-256 |
a59a1fbe8d3d927a2da45b5e9ca5da4d0d9a5ae77d95313f9d7169251b1d4b2c
|
Provenance
The following attestation bundles were made for vaquum_limen-2.5.6.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-2.5.6.tar.gz -
Subject digest:
414b3a90e23bbc694cb26ce9c6c05583c360745cafb01bda31b83f622ce72dc4 - Sigstore transparency entry: 1397510137
- Sigstore integration time:
-
Permalink:
Vaquum/Limen@e2511faa6bbde8658c6e9cdbcf19e3049e31720b -
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@e2511faa6bbde8658c6e9cdbcf19e3049e31720b -
Trigger Event:
workflow_run
-
Statement type:
File details
Details for the file vaquum_limen-2.5.6-py3-none-any.whl.
File metadata
- Download URL: vaquum_limen-2.5.6-py3-none-any.whl
- Upload date:
- Size: 343.2 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 |
85f87f652a982092bc3d67f801791a57838406cbf6ff9908cd6757c2b7a668f9
|
|
| MD5 |
89ec71dd234d162c296f656652c4c2ea
|
|
| BLAKE2b-256 |
4fc321495371c9bcbb2a5f513940ee83092c46fd571868f3b06b73ce919e4a84
|
Provenance
The following attestation bundles were made for vaquum_limen-2.5.6-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-2.5.6-py3-none-any.whl -
Subject digest:
85f87f652a982092bc3d67f801791a57838406cbf6ff9908cd6757c2b7a668f9 - Sigstore transparency entry: 1397510153
- Sigstore integration time:
-
Permalink:
Vaquum/Limen@e2511faa6bbde8658c6e9cdbcf19e3049e31720b -
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@e2511faa6bbde8658c6e9cdbcf19e3049e31720b -
Trigger Event:
workflow_run
-
Statement type: