Blyx

Merganser

Workflow framework · 0.1.0

Report drawdown depth and time below the running peak for a historical series.

Measure a loss that recovered before the final observation

The sample falls from 100 to 75 and recovers. Its depth meets the limit but its time below peak exceeds the duration limit.

Run the native CLI

Extract the workflow collection for your platform. Run .\bin\merganser.exe --help in PowerShell or ./bin/merganser --help on Linux and macOS. Running the command with no arguments prints the worked example.

Build from source

With Blyx 0.2.1, Rust and a host linker installed, run these commands to edit and rebuild the example.

git clone --depth 1 --branch v0.1.0 https://github.com/Rahulchaube1/blyx-merganser.git
cd blyx-merganser
blyxc native-run project.blyx -- "100,80,75,100" 0.25 1

Why this framework exists

A recovered account can finish near its starting value while hiding a long underwater spell. Keep depth and duration visible together. QuantConnect, backtest reports

Install Merganser in your editor

Extension RahulChaube.blyx-merganser · 0.1.0

The extension includes a runnable Blyx example, function completions and the framework source. For the modular project, extract the starter, open its folder and run blyxc native-run main.blyx with the native toolchain installed.

Create an empty .blyx file, type blyx-merganser-demo and accept the completion. Choose Blyx: Run File to run the example.

For an offline installation, choose Extensions: Install from VSIX for Blyx Language first, then for Merganser.

Download the companion Blyx Language VSIX

Libraries in this framework

Install with Conda

Create an environment containing Merganser 0.1.0, its Blyx source and a runnable example. Run the second command with Blyx 0.2.1, Rust and a host linker installed.

conda create -y --prefix ./blyx-env --override-channels -c https://rahulchaube1.github.io/blyx-packages blyx-merganser=0.1.0=0
blyxc native-run ./blyx-env/share/blyx/merganser/main.blyx

To use this package in your application, copy share/blyx/merganser/vendor/merganser from the environment into your project's vendor directory.

Install the full collection with Homebrew or Scoop

Import into a Blyx project

Install Blyx 0.2.1, Rust 1.85 or newer and a host linker. From the directory containing your entry file, clone this tagged release.

git clone --depth 1 --branch v0.1.0 https://github.com/Rahulchaube1/blyx-merganser.git vendor/merganser

You can also download Merganser as a ZIP. Extract its contents into vendor/merganser.

Save this as main.blyx beside vendor and run blyxc native-run main.blyx.

use vendor::merganser::merganser;

fn main() {
    let equity = [100, 80, 75, 100];
    let depth_limit = 0.25;
    let duration_limit = 1.0;
    let result = merganser_report(equity, depth_limit, duration_limit);
    if len(result) == 0 { println!("invalid"); return; }
    let mut i = 0;
    while i < len(result) {
        println!(at(result, i));
        i += 1;
    }
}

Expected output

0.25
0
2
2
1

API and input requirements

Returns [deepest fractional loss, peak index, trough index, longest underwater spell, limit breached]. Durations count observations, not calendar days. Invalid arguments and nonfinite results return an empty vector.

APIUse
merganser_report(equity, depth_limit, duration_limit)Returns [deepest fractional loss, peak index, trough index, longest underwater spell, limit breached]. Durations count observations, not calendar days.

Develop and contribute

Open the tagged source to read the implementation and examples. Include the smallest reproducible Blyx program, compiler version and expected result when reporting an issue.