Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- `buildPathMonteCarloSimulation` in `@kiploks/engine-core`: path-based i.i.d. bootstrap over equity period returns; CAGR and max drawdown distributions, labels, `interpretation`, `meta` (`PATH_MONTE_CARLO_METHOD_VERSION`, currently **1.1.0**).
- `calculateCagrFromYears` in `financialMath.ts`.
- Contract types in `@kiploks/engine-contracts`: `PathMonteCarloResult`, `PathMonteCarloOptions`, `PathMonteCarloEquityPoint`, `DistributionStats` (incl. optional `varCornishFisher95`), extended `PathMonteCarloMeta`.
- `packages/core/src/prng.ts` shared `createMulberry32` (path MC, professional window bootstrap, WFE).
- `packages/core/src/prng.ts` - shared `createMulberry32` (path MC, professional window bootstrap, WFE).
- `AnalyzeConfig.monteCarloBootstrapN` for precomputed `analyzeFromWindows` (professional `monteCarloValidation` iterations; default 1000, clamp 100-50000).
- Docs: `MONTE_CARLO_PATH.md`, `MONTE_CARLO_SIMULATION_IMPLEMENTATION.md`, `examples/monte-carlo-example.md`, golden `examples/monte-carlo-seed42.json`, `npm run engine:examples:generate-monte-carlo-fixture`. Demo tab in `examples/result-layout-demo.html`.

Expand Down
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,24 @@
# Kiploks Engine (Open Core)
# Kiploks Trading Robustness Engine (Open Core)

## ✨ New: easier Freqtrade bot testing in UI

You can now run Freqtrade bot tests directly from the web interface with much less setup friction.

https://github.com/user-attachments/assets/b376f964-ab70-44ef-b8f6-bc3fd19f4e21

```bash
npm install
npm run ui
# or without global install:
npx -y @kiploks/engine-cli ui --watch
```


- Pick a specific backtest artifact from the list, or run in `Auto (top_n)` mode.
- Start integration runs from a cleaner Step 4 workspace with collapsible sections.
- Get report links in run logs after successful local runs, so you can open results right away.
- Report title handling is automatic and predictable when switching between artifact and [top_n](https://github.com/kiploks/engine/blob/main/docs/BOT_INTEGRATIONS.md) modes.


[![npm](https://img.shields.io/npm/v/@kiploks/engine-core)](https://www.npmjs.com/package/@kiploks/engine-core)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
Expand Down
12 changes: 6 additions & 6 deletions docs/ENTRYPOINTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ Optional **`equityCurve`** on the input can help unlock benchmark-related paths

## Troubleshooting: `available: false` and warnings

A block with **`available: false`** is **not a crash** it means the engine **refuses to fake** that block because required inputs are missing. Read **`reason`** on the block (`KiploksUnavailableReason` in [`packages/contracts/src/errors.ts`](../packages/contracts/src/errors.ts)).
A block with **`available: false`** is **not a crash** - it means the engine **refuses to fake** that block because required inputs are missing. Read **`reason`** on the block (`KiploksUnavailableReason` in [`packages/contracts/src/errors.ts`](../packages/contracts/src/errors.ts)).

For **behavioral cautions** (low trade count, low window count, weak p-value, etc.), see **`warnings[]`** on the result and the full **[`ERROR_CATALOG.md`](ERROR_CATALOG.md)**.

Expand All @@ -167,8 +167,8 @@ When contracts change, **this file can go stale**. Prefer:

## See also

- **[`OPEN_CORE_INTEGRATION_PRINCIPLES.md`](OPEN_CORE_INTEGRATION_PRINCIPLES.md)** design principles and `runEverything()`.
- **[`examples-map-payload-to-unified.md`](examples-map-payload-to-unified.md)** `mapPayloadToUnified` and CSV-first flow.
- **[`examples/README.md`](examples/README.md)** step-by-step examples.
- **[`ERROR_CATALOG.md`](ERROR_CATALOG.md)** warning and error codes.
- **[`MONTE_CARLO_SIMULATION_IMPLEMENTATION.md`](MONTE_CARLO_SIMULATION_IMPLEMENTATION.md)** path MC vs window bootstrap index.
- **[`OPEN_CORE_INTEGRATION_PRINCIPLES.md`](OPEN_CORE_INTEGRATION_PRINCIPLES.md)** - design principles and `runEverything()`.
- **[`examples-map-payload-to-unified.md`](examples-map-payload-to-unified.md)** - `mapPayloadToUnified` and CSV-first flow.
- **[`examples/README.md`](examples/README.md)** - step-by-step examples.
- **[`ERROR_CATALOG.md`](ERROR_CATALOG.md)** - warning and error codes.
- **[`MONTE_CARLO_SIMULATION_IMPLEMENTATION.md`](MONTE_CARLO_SIMULATION_IMPLEMENTATION.md)** - path MC vs window bootstrap index.
Loading
Loading