Download Options

Installation

For detailed installation instructions, please see the Getting Started guide. Basic installation steps:

# Using npm
npm install @dragonfire/merlin-sdk

# Using yarn
yarn add @dragonfire/merlin-sdk

# Or include directly in HTML
<script src="https://cdn.dragonfire.ai/sdk/merlin/1.3.2/merlin-sdk.min.js"></script>

# Extract the SDK package
tar -xzf merlin-sdk-1.3.2.tar.gz
cd merlin-sdk-1.3.2

# Configure with CMake
mkdir build && cd build
cmake .. -DCMAKE_BUILD_TYPE=Release -DBUILD_EXAMPLES=ON

# Build and install
make
sudo make install

# Using pip
pip install dragonfire-merlin

# From downloaded package
pip install merlin-sdk-1.3.0.tar.gz

# With conda
conda install -c dragonfire merlin

Compression Modes

Merlin offers several compression modes optimized for different types of data and performance requirements:

System Requirements

JavaScript SDK

• Browser Support: Chrome 60+, Firefox 53+, Safari 11+, Edge 16+
• Node.js: 12.0.0 or higher
• WebAssembly: Required for optimal performance
• Memory: At least 4MB available memory (more for larger compression tasks)

C/C++ SDK

• Operating Systems: Linux (Ubuntu 18.04+, CentOS 7+), macOS 10.13+, Windows 10+
• Compiler: GCC 5+, Clang 5+, MSVC 2017+
• Optional Dependencies: zlib 1.2.11+ (for interoperability), libomp (for parallel processing)
• CPU: x86_64 with SSE4.1 support (AVX/AVX2/AVX-512 recommended for optimal performance)
• Memory: At least 16MB RAM, scales based on input data size and compression level

Python SDK

• Python: 3.7 or higher
• Optional Packages: NumPy 1.16+ (for array compression), Pandas 1.0+ (for DataFrame support)
• Operating Systems: Linux, macOS, Windows
• Pre-built Wheels: Available for most common platforms (manylinux2014, macOS 10.13+, Windows)

Key Features

Licensing

Performance Benchmarks

Merlin compression performance compared to standard algorithms with various data types:

Note: Compression ratios are highly dependent on data characteristics. For detailed performance analysis and methodology, see the complete benchmarks page.

Getting Started

After downloading the SDK, visit our Documentation for detailed information on installation, configuration, and basic usage.

Quick Example

// JavaScript Example
import { MerlinCompressor } from '@dragonfire/merlin-sdk';

// Create a compressor with harmonic mode
const compressor = new MerlinCompressor({
  mode: 'harmonic',
  compressionLevel: 7,
  dictionary: 'adaptive'
});

// Compress data
async function compressData(inputData) {
  // Initialize the compressor
  await compressor.initialize();
  
  // Compress the data
  const compressed = await compressor.compress(inputData);
  console.log(`Original size: ${inputData.length} bytes`);
  console.log(`Compressed size: ${compressed.length} bytes`);
  console.log(`Compression ratio: ${(inputData.length / compressed.length).toFixed(2)}x`);
  
  // Decompress the data to verify integrity
  const decompressed = await compressor.decompress(compressed);
  console.log(`Decompression successful: ${inputData.length === decompressed.length}`);
  
  return compressed;
}

// Stream processing example
async function compressStream(readableStream, writableStream) {
  const streamCompressor = compressor.createStreamCompressor();
  
  // Pipe the streams
  readableStream
    .pipe(streamCompressor)
    .pipe(writableStream);
  
  // Monitor progress
  streamCompressor.on('progress', (stats) => {
    console.log(`Processed: ${stats.inputBytes} bytes, Compression ratio: ${stats.ratio.toFixed(2)}x`);
  });
  
  return new Promise((resolve, reject) => {
    writableStream.on('finish', resolve);
    writableStream.on('error', reject);
  });
}