Documentation Index

This comprehensive index helps you quickly find information across all Planar documentation.

Topics by Category

Getting Started

• Installation - Docker, Source
• Quick Start - 15-minute tutorial
• First Strategy - Tutorial, Examples

Strategy Development

• Strategy Basics - Architecture, Dispatch System
• Strategy Creation - Interactive Generator, Manual Setup
• Strategy Loading - Runtime Loading, Configuration
• Advanced Patterns - Multi-timeframe, Portfolio Rebalancing
• Margin Trading - Concepts, Position Management

Data Management

• Storage - Zarr Backend, LMDB, Organization
• Historical Data - Scrapers, Binance Archives
• Real-time Data - Fetch Module, Rate Limits
• Live Streaming - Watchers, OHLCV Tickers

Execution Modes

• Backtesting - Configuration, Performance
• Paper Trading - Setup, Real-time Simulation
• Live Trading - API Setup, Risk Management, Monitoring
• Mode Comparison - Feature Matrix, Transition Guide

Optimization

• Methods - Grid Search, Bayesian Optimization
• Configuration - Parameter Definition, Objective Functions
• Results - Analysis, Visualization

Visualization

• Chart Types - OHLCV, Trade Visualization
• Customization - Styling, Interactivity
• Backends - GLMakie, WGLMakie

Customization

• Dispatch System - Overview, Patterns
• Custom Orders - Implementation, Examples
• Exchange Extensions - Adding Exchanges, Custom Behavior

Function Index

Core Functions

• strategy() - Strategy Loading
• start!() - Backtesting, Strategy Execution
• call!() - Dispatch System, Strategy Interface
• fetch_ohlcv() - Data Fetching
• load_ohlcv() - Data Loading

Data Functions

• fetch_candles() - Raw Data Fetching
• binancedownload() - Historical Data
• binanceload() - Data Loading

Order Functions

• MarketOrder() - Order Types
• LimitOrder() - Order Types
• StopOrder() - Order Types

Analysis Functions

• sharpe() - Performance Metrics
• sortino() - Performance Metrics
• maxdrawdown() - Risk Metrics

Plotting Functions

• balloons() - Trade Visualization
• ohlcv() - OHLCV Charts
• plot_optimization() - Optimization Results

Configuration Topics

Strategy Configuration

• Constants - DESCRIPTION, EXC, MARGIN, TF
• Environment Macros - @strategyenv!, @contractsenv!, @optenv!
• Parameters - Strategy Attributes

System Configuration

• Environment Variables - JULIAPROJECT, JULIANUM_THREADS
• Exchange APIs - API Keys, Sandbox Mode
• Data Storage - LMDB Configuration

Error Handling

Common Issues

• Installation Problems - Dependency Conflicts
• Strategy Loading - Module Not Found
• Data Issues - Missing Data
• Order Execution - Insufficient Funds

Debugging

• Logging - Strategy Debugging
• State Inspection - Debug Methods
• Performance - Profiling

File Locations

User Files

• Strategies - user/[strategies](guides/../guides/strategy-development.md)/
• Configuration - user/[planar.toml](config.md#configuration)-file)
• Secrets - user/[secrets.toml](config.md#secrets-management)
• Data - user/data.mdb, user/lock.mdb

Documentation

• Source - docs/src/
• API Reference - docs/src/API/
• Examples - user/[strategies](guides/../guides/strategy-development.md)/QuickStart/examples/

Search Keywords

Trading Concepts

• OHLCV, Candlestick, Timeframe, Exchange, Pair, Symbol
• Long, Short, Position, Margin, Leverage, Isolated, Cross
• Buy, Sell, Order, Trade, Execution, Slippage, Fees
• Backtest, Paper Trading, Live Trading, Simulation

Technical Concepts

• Dispatch, Multiple Dispatch, Type System, Parametric Types
• Strategy, Module, Function, Method, Interface
• Data, Storage, Zarr, LMDB, Fetch, Scraper, Watcher
• Optimization, Grid Search, Bayesian, Parameter Tuning

Performance Concepts

• Sharpe Ratio, Sortino Ratio, Maximum Drawdown, Volatility
• Return, Profit, Loss, Risk, Portfolio, Allocation
• Benchmark, Alpha, Beta, Correlation, Statistics

See Also

• Exchanges - Exchange integration and configuration
• Config - Exchange integration and configuration
• Overview - Troubleshooting: Troubleshooting and problem resolution
• Optimization - Performance optimization techniques
• Performance Issues - Troubleshooting: Performance optimization techniques
• Data Management - Guide: Data handling and management

Quick Reference

Essential Commands

Key File Paths

• Strategy files: user/[strategies](guides/../guides/strategy-development.md)/StrategyName.jl
• Configuration: user/[planar.toml](config.md#configuration-file)
• Documentation: docs/src/
• Examples: user/strategies/QuickStart/examples/

Important Links

• Getting Started - Begin here
• Strategy Guide - Core development guide
• API Reference - Complete function documentation
• Troubleshooting - Problem solving
• Community - Get help and support