User Guide - Руководство пользователя BQuant

📖 Обзор

Руководство пользователя BQuant содержит всю необходимую информацию для эффективного использования библиотеки.

📚 Содержание

🚀 Quick Start - Быстрый старт

  • Установка BQuant

  • Первый анализ за 5 минут

  • Основные концепции

🧠 Core Concepts - Базовые концепции

  • Универсальный пайплайн Zone Analysis

  • Конфигурация индикаторов и стратегий

  • Как интерпретировать результаты ZoneAnalysisResult

  • Переход к практическим сценариям

🔄 Zone Analysis Guide - Полный пайплайн анализа зон

  • Детальная архитектура системы

  • Пошаговое выполнение pipeline

  • Стратегии детекции зон (ZeroCrossing, Threshold, LineCrossing, Preloaded, Combined)

  • Извлечение признаков и анализ

  • Модели данных (ZoneInfo, ZoneAnalysisResult)

  • Примеры использования от простых до продвинутых

  • Кэширование и персистентность

💾 Caching Reference - Справочник по кэшированию

  • Архитектура кэша (memory + disk)

  • Где хранится кэш, как настраивать

  • Когда и как очищать кэш

  • Zone Analysis: формирование ключей, авто-инвалидация

Best Practices - Практика анализа зон

  • Когда выбирать полный пайплайн vs модульные шаги

  • Рекомендуемая структура хранения артефактов

  • Паттерны переиспользования результатов

  • Версионирование и интеграция с внешними системами

🏗️ Core Modules - Основные модули

  • Архитектура BQuant

  • Основные компоненты

  • Принципы работы

📊 Data Management - Работа с данными

  • Загрузка данных

  • Обработка и очистка

  • Валидация данных

  • Sample данные

📈 Technical Analysis - Технический анализ

  • Universal Zone Analysis Pipeline v2.1

  • Анализ зон с любыми индикаторами (MACD, RSI, AO, custom)

  • Создание индикаторов

  • «Простой способ» работы с pandas-ta через LibraryManager

📊 Visualization - Визуализация

  • Создание графиков

  • Настройка тем

  • Экспорт графиков

  • Интерактивные элементы

🔬 Statistical Analysis - Статистический анализ

  • Гипотезное тестирование

  • Анализ распределений

  • Корреляционный анализ

  • Интерпретация результатов

Performance - Производительность

  • Оптимизация алгоритмов

  • Кэширование

  • Профилирование

  • Масштабирование

🔧 Configuration - Конфигурация

  • Настройка параметров

  • Логирование

  • Обработка ошибок

  • Пользовательские настройки

🎯 Целевая аудитория

Это руководство предназначено для:

  • Аналитиков данных - работа с финансовыми данными

  • Трейдеров - технический анализ и индикаторы

  • Исследователей - статистический анализ и тестирование гипотез

  • Разработчиков - интеграция BQuant в свои проекты

📋 Предварительные требования

Базовые знания

  • Python 3.11+

  • Основы работы с pandas и numpy

  • Понимание финансовых данных (OHLCV)

Установленные библиотеки

pip install pandas numpy matplotlib seaborn plotly

🚀 Начать изучение

Рекомендуемый порядок изучения:

  1. Quick Start - Быстрый старт

  2. Core Concepts - Ключевые идеи Universal Pipeline

  3. Zone Analysis Guide - Детальное описание пайплайна анализа зон

  4. Best Practices - Практические рекомендации и рабочие паттерны

  5. Core Modules - Основные модули

  6. Data Management - Работа с данными

  7. Technical Analysis aka Indicators - Universal Zone Analysis v2.1

  8. Visualization - Визуализация

  9. Statistical Analysis - Статистический анализ

💡 Советы по изучению

  • Практикуйтесь - Используйте sample данные для экспериментов

  • Изучайте примеры - Смотрите папку examples/ для готовых решений

  • Задавайте вопросы - Используйте GitHub Issues для вопросов

  • Вносите вклад - Делитесь своими примерами и улучшениями

🔗 Связанные разделы

  • API Reference - Подробная документация API

  • Tutorials - Обучающие материалы

  • Examples - Примеры использования

  • Developer Guide - Для разработчиков

  • MIGRATION_v2 - Переход со старого MACDZoneAnalyzer


Следующий шаг: Quick Start 🚀