nyxs_owl 0.4.0

A comprehensive Rust library for trading, forecasting, and financial analysis
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

//! # Trading Strategies Library
//!
//! A Rust library implementing various trading strategies based on technical indicators
//! from the RusTaLib crate. This library is part of the NyxsOwl workspace.
//!
//! ## Usage Options
//!
//! There are three main ways to use this library:
//!
//! ### Option 1: Direct imports from root (most concise)
//!
//! ```rust
//! // Import specific items directly from the root
//! use strategy_lib::{Strategy, StrategyConfig, run_backtest, BacktestConfig};
//! use strategy_lib::strategy::trend_following::MovingAverageCrossover;
//!
//! // Create and use a strategy
//! let strategy = MovingAverageCrossover::new(config);
//! let results = run_backtest(&strategy, &data, BacktestConfig::default()).unwrap();
//! ```
//!
//! ### Option 2: Using the prelude module (recommended)
//!
//! ```rust
//! // Import everything commonly needed
//! use strategy_lib::prelude::*;
//!
//! // Create and use a strategy
//! let strategy = MovingAverageCrossover::new(config);
//! let results = run_backtest(&strategy, &data, BacktestConfig::default()).unwrap();
//! ```
//!
//! ### Option 3: Using the nested module structure
//!
//! ```rust
//! // Import from specific modules
//! use strategy_lib::strategy::{Strategy, StrategyConfig};
//! use strategy_lib::strategy::trend_following::MovingAverageCrossover;
//! use strategy_lib::backtest::{run_backtest, BacktestConfig};
//!
//! // Create and use a strategy
//! let strategy = MovingAverageCrossover::new(config);
//! let results = run_backtest(&strategy, &data, BacktestConfig::default()).unwrap();
//! ```
//!
//! ## Strategy Categories
//!
//! This library organizes strategies into several categories:
//!
//! - **Trend-Following Strategies**: Strategies that aim to capture market trends
//! - **Mean-Reversion Strategies**: Strategies that capitalize on price returning to the mean
//! - **Momentum Strategies**: Strategies that trade based on market momentum
//! - **Volatility Strategies**: Strategies that trade based on market volatility
//! - **Volume Strategies**: Strategies that use volume as a primary signal
//! - **Multi-Indicator Strategies**: Strategies that combine multiple indicators

pub mod backtest;
pub mod prelude;
pub mod strategy;
pub mod utils;

// Re-export commonly used items for convenience
pub use backtest::{run_backtest, BacktestConfig, BacktestMetrics, BacktestResults};
pub use strategy::{Signal, Strategy, StrategyConfig, StrategyError};

// Re-export specific strategies for direct access
pub use strategy::trend_following::MovingAverageCrossover;

#[cfg(test)]
mod tests {
    #[test]
    fn it_works() {
        assert_eq!(2 + 2, 4);
    }
}