optionstratlib 0.16.2

OptionStratLib is a comprehensive Rust library for options trading and strategy development across multiple asset classes.
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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142

/******************************************************************************
   Author: Joaquín Béjar García
   Email: jb@taunais.com
   Date: 25/8/25
******************************************************************************/

//! # OptionStratLib Prelude
//!
//! The prelude module provides a convenient way to import the most commonly used
//! types, traits, and functions from the OptionStratLib library. This module is
//! designed to reduce the amount of boilerplate imports needed when working with
//! the library.
//!
//! ## Usage
//!
//! Add this to your imports to get access to the most commonly used items:
//!
//! ```rust
//! use optionstratlib::prelude::*;
//! ```
//!
//! This will import all the essential types and traits you need for most
//! options trading and strategy development tasks.

// Core model types
pub use crate::model::{
    BasicAxisTypes, ExpirationDate, Options, Position, Trade,
    types::{Action, OptionStyle, OptionType, Side},
};
pub use crate::strategies::{
    StrategyConstructor,
    base::{
        BasicAble, BreakEvenable, Optimizable, Positionable, Strategable, Strategies, StrategyType,
        Validable,
    },
    // Specific strategy implementations (commonly used)
    bear_call_spread::BearCallSpread,
    bear_put_spread::BearPutSpread,
    bull_call_spread::BullCallSpread,
    bull_put_spread::BullPutSpread,
    call_butterfly::CallButterfly,
    collar::Collar,
    covered_call::CoveredCall,
    custom::CustomStrategy,
    delta_neutral::{
        AdjustmentAction, AdjustmentConfig, AdjustmentError, AdjustmentOptimizer, AdjustmentPlan,
        AdjustmentTarget, DeltaNeutrality, PortfolioGreeks,
    },
    iron_butterfly::IronButterfly,
    iron_condor::IronCondor,
    long_butterfly_spread::LongButterflySpread,
    long_call::LongCall,
    long_put::LongPut,
    long_straddle::LongStraddle,
    long_strangle::LongStrangle,
    poor_mans_covered_call::PoorMansCoveredCall,
    probabilities::ProbabilityAnalysis,
    protective_put::ProtectivePut,
    short_butterfly_spread::ShortButterflySpread,
    short_call::ShortCall,
    short_put::ShortPut,
    short_straddle::ShortStraddle,
    short_strangle::ShortStrangle,
    utils::FindOptimalSide,
};

// Greeks calculations
pub use crate::greeks::*;

// Pricing and profit calculations
pub use crate::pricing::payoff::*;
pub use crate::pricing::*;

// PnL calculations
pub use crate::pnl::{PnL, PnLCalculator};

pub use crate::backtesting::*;

// Visualization
pub use crate::visualization::{Graph, GraphData, Series2D, Surface3D, TraceMode};

#[cfg(feature = "plotly")]
pub use crate::visualization::utils::make_surface;

// Chain operations
pub use crate::chains::{OptionData, StrategyLegs, chain::OptionChain, utils::OptionChainParams};

// Curves and surfaces
pub use crate::curves::{BasicCurves, Curvable, Curve, Point2D, StatisticalCurve};
pub use crate::surfaces::{BasicSurfaces, Point3D, Surfacable, Surface};

// Geometrics (commonly used in curve examples)
pub use crate::geometrics::{ConstructionMethod, ConstructionParams, GeometricObject, Plottable};

// Volatility models
pub use crate::volatility::*;

// Performance metrics
pub use crate::metrics::*;

// Error types (most commonly encountered)
pub use crate::error::{
    ChainError, CurveError, DecimalError, Error, GraphError, GreeksError, InterpolationError,
    MetricsError, OhlcvError, OperationErrorKind, OptionsError, PositionError, PricingError,
    ProbabilityError, StrategyError, SurfaceError, TransactionError, VolatilityError,
};

// Utility functions and traits
pub use crate::model::utils::ToRound;
pub use crate::utils::{
    Len, OhlcvCandle, TimeFrame,
    others::calculate_log_returns,
    read_ohlcv_from_zip, setup_logger,
    time::{convert_time_frame, get_tomorrow_formatted, get_x_days_formatted},
};

// Commonly used external dependencies
pub use chrono::Utc;
pub use positive::{Positive, assert_pos_relative_eq, pos_or_panic, spos};
pub use rust_decimal::Decimal;
pub use rust_decimal::prelude::ToPrimitive;
pub use rust_decimal_macros::dec;
pub use std::path::Path;

// Simulation types and functions
pub use crate::simulation::{
    ExitPolicy, Simulate, SimulationStats, WalkParams, WalkType, WalkTypeAble, WalkTypeAbleClone,
    check_exit_policy,
    randomwalk::RandomWalk,
    simulator::Simulator,
    steps::{Step, Xstep, Ystep},
};

// Chain and series types and generators
pub use crate::chains::{
    OptionChainBuildParams, generator_optionchain, generator_positive, utils::OptionDataPriceParams,
};
pub use crate::series::{OptionSeries, OptionSeriesBuildParams, generator_optionseries};

// Volatility functions
pub use crate::volatility::{adjust_volatility, constant_volatility};
pub use tracing::{debug, error, info, trace, warn};