diff --git a/.Jules/palette.md b/.Jules/palette.md index 5de3a38..f00829e 100644 --- a/.Jules/palette.md +++ b/.Jules/palette.md @@ -1,3 +1,7 @@ ## 2024-05-22 - Visual Hierarchy in CLI Output **Learning:** Adding color-coded indicators (Green/Red) and emojis (💰, 📉) in CLI tools significantly reduces cognitive load when parsing financial data streams. It transforms a wall of text into a scannable narrative. **Action:** For data-heavy CLI applications, always implement a semantic color system and visual anchors (icons/emojis) for key events. + +## 2024-05-23 - CLI Configurability and Noise Reduction +**Learning:** Hardcoded values in CLI tools limit usability. Providing arguments for key parameters (like `--days`, `--initial-cash`) empowers users. Additionally, offering a `--quiet` flag to suppress verbose logging (while keeping critical events) and a `--no-color` flag for accessibility/logging is essential for a polished CLI experience. +**Action:** Always implement `argparse` (or similar) with quiet and no-color options for CLI tools that produce significant output. diff --git a/.gitignore b/.gitignore index d4fb281..907591b 100644 --- a/.gitignore +++ b/.gitignore @@ -39,3 +39,7 @@ # debug information files *.dwo + +# Python +__pycache__/ +*.pyc diff --git a/README.md b/README.md index be561ef..768851e 100644 --- a/README.md +++ b/README.md @@ -20,12 +20,28 @@ pip install -r requirements.txt ## Usage -Run the simulation script: +Run the simulation script with default settings: ```bash python bitcoin_trading_simulation.py ``` +### CLI Options + +You can customize the simulation using the following arguments: + +- `--days`: Number of days to simulate (default: 60) +- `--initial-cash`: Initial cash in USD (default: 10000) +- `--initial-price`: Initial Bitcoin price in USD (default: 50000) +- `--volatility`: Volatility factor (default: 0.02) +- `--quiet`, `-q`: Suppress daily portfolio logs (only show buy/sell events and final summary) +- `--no-color`: Disable colored output (useful for logs or non-ANSI terminals) + +Example: +```bash +python bitcoin_trading_simulation.py --days 100 --initial-cash 5000 --quiet +``` + ## Tests Run the test suite: diff --git a/__pycache__/test_bitcoin_trading.cpython-312-pytest-9.0.2.pyc b/__pycache__/test_bitcoin_trading.cpython-312-pytest-9.0.2.pyc new file mode 100644 index 0000000..5f2e573 Binary files /dev/null and b/__pycache__/test_bitcoin_trading.cpython-312-pytest-9.0.2.pyc differ diff --git a/bitcoin_trading_simulation.py b/bitcoin_trading_simulation.py index 82df43f..299d36f 100644 --- a/bitcoin_trading_simulation.py +++ b/bitcoin_trading_simulation.py @@ -1,6 +1,8 @@ +import argparse import numpy as np import pandas as pd + class Colors: HEADER = '\033[95m' BLUE = '\033[94m' @@ -9,6 +11,7 @@ class Colors: ENDC = '\033[0m' BOLD = '\033[1m' + def simulate_bitcoin_prices(days=60, initial_price=50000, volatility=0.02): """ Simulates Bitcoin prices for a given number of days using Geometric Brownian Motion. @@ -23,6 +26,7 @@ def simulate_bitcoin_prices(days=60, initial_price=50000, volatility=0.02): prices.append(prices[-1] + price_change) return pd.Series(prices, name='Price') + def calculate_moving_averages(prices, short_window=7, long_window=30): """ Calculates short and long moving averages for a given price series. @@ -33,6 +37,7 @@ def calculate_moving_averages(prices, short_window=7, long_window=30): signals['long_mavg'] = prices.rolling(window=long_window, min_periods=1, center=False).mean() return signals + def generate_trading_signals(signals): """ Generates trading signals based on the Golden Cross strategy. @@ -49,7 +54,8 @@ def generate_trading_signals(signals): signals['positions'] = signals['signal'].diff().shift(1) return signals -def simulate_trading(signals, initial_cash=10000): + +def simulate_trading(signals, initial_cash=10000, quiet=False): """ Simulates trading based on signals and prints a daily ledger. """ @@ -81,13 +87,36 @@ def simulate_trading(signals, initial_cash=10000): portfolio.loc[i, 'btc'] = 0 portfolio.loc[i, 'total_value'] = portfolio.loc[i, 'cash'] + portfolio.loc[i, 'btc'] * row['price'] - print(f"Day {i}: Portfolio Value: ${portfolio.loc[i, 'total_value']:.2f}, Cash: ${portfolio.loc[i, 'cash']:.2f}, BTC: {portfolio.loc[i, 'btc']:.4f}") + if not quiet: + print( + f"Day {i}: Portfolio Value: ${portfolio.loc[i, 'total_value']:.2f}, " + f"Cash: ${portfolio.loc[i, 'cash']:.2f}, BTC: {portfolio.loc[i, 'btc']:.4f}" + ) return portfolio + if __name__ == "__main__": + parser = argparse.ArgumentParser(description='Bitcoin Trading Simulation') + parser.add_argument('--days', type=int, default=60, help='Number of days to simulate') + parser.add_argument('--initial-cash', type=float, default=10000, help='Initial cash in USD') + parser.add_argument('--initial-price', type=float, default=50000, help='Initial Bitcoin price in USD') + parser.add_argument('--volatility', type=float, default=0.02, help='Volatility factor') + parser.add_argument('--quiet', '-q', action='store_true', help='Suppress daily portfolio logs') + parser.add_argument('--no-color', action='store_true', help='Disable colored output') + + args = parser.parse_args() + + if args.no_color: + Colors.HEADER = '' + Colors.BLUE = '' + Colors.GREEN = '' + Colors.RED = '' + Colors.ENDC = '' + Colors.BOLD = '' + # Simulate prices - prices = simulate_bitcoin_prices() + prices = simulate_bitcoin_prices(days=args.days, initial_price=args.initial_price, volatility=args.volatility) # Calculate moving averages signals = calculate_moving_averages(prices) @@ -96,11 +125,11 @@ def simulate_trading(signals, initial_cash=10000): signals = generate_trading_signals(signals) # Simulate trading - portfolio = simulate_trading(signals) + portfolio = simulate_trading(signals, initial_cash=args.initial_cash, quiet=args.quiet) # Final portfolio performance final_value = portfolio['total_value'].iloc[-1] - initial_cash = 10000 + initial_cash = args.initial_cash profit = final_value - initial_cash # Compare with buy and hold strategy diff --git a/test.py b/test_bitcoin_trading.py similarity index 100% rename from test.py rename to test_bitcoin_trading.py