Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 3 additions & 7 deletions .Jules/palette.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
## 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 Accessibility and Control
**Learning:** While color and emojis enhance UX, they can be inaccessible (color blindness) or intrusive (automation logs). Providing `--no-color` and `--quiet` flags is essential for a robust CLI tool that respects user context and accessibility needs.
**Action:** Always include flags to disable visual enhancements and suppress verbose output in CLI tools.
## 2024-05-22 - Signal vs Noise in CLI Logs
**Learning:** Users running simulations care about *events*, not *progress*. A daily log of "nothing happened" drowns out critical Buy/Sell signals.
**Action:** For event-driven CLIs, suppress "heartbeat" logs. Highlight state changes with colors/icons to improve scanability.
101 changes: 0 additions & 101 deletions .github/workflows/codeql.yml

This file was deleted.

4 changes: 0 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,3 @@

# debug information files
*.dwo

# Python
__pycache__/
*.pyc
58 changes: 2 additions & 56 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,56 +1,2 @@
# Bitcoin Trading Simulation

A Python-based CLI tool that simulates Bitcoin trading using a 'Golden Cross' moving average strategy. It generates synthetic price data using Geometric Brownian Motion, executes trades based on technical indicators, and provides a daily ledger with a final performance summary.

## Features

- **Price Simulation:** Uses Geometric Brownian Motion to simulate Bitcoin prices.
- **Trading Strategy:** Implements a Golden Cross strategy (Short MA > Long MA = Buy, Short MA < Long MA = Sell).
- **Rich CLI Output:** Features color-coded logs (Green for Buy/Profit, Red for Sell/Loss) and emojis for better readability.
- **Performance metrics:** Compares the strategy's performance against a "Buy and Hold" approach.
- **Customizable:** Configure simulation parameters via command-line arguments.

## Installation

1. Clone the repository.
2. Install the required dependencies:

```bash
pip install -r requirements.txt
```

## Usage

Run the simulation script with default settings (60 days, $10k initial cash):

```bash
python bitcoin_trading_simulation.py
```

### Options

Customize the simulation with the following arguments:

```bash
python bitcoin_trading_simulation.py --days 100 --initial-cash 5000 --initial-price 60000 --volatility 0.03
```

- `--days`: Number of days to simulate (default: 60)
- `--initial-cash`: Initial cash amount (default: 10000)
- `--initial-price`: Initial Bitcoin price (default: 50000)
- `--volatility`: Price volatility (default: 0.02)
- `--quiet`: Suppress daily portfolio log (only show final result)
- `--no-color`: Disable colored output (for accessibility or logging)

Example:
```bash
python bitcoin_trading_simulation.py --days 30 --quiet --no-color
```

## Tests

Run the test suite using `pytest`:

```bash
pytest
```
# code
Programming with C++ code
Binary file modified __pycache__/bitcoin_trading_simulation.cpython-312.pyc
Binary file not shown.
Binary file removed __pycache__/test_bitcoin_trading.cpython-312.pyc
Binary file not shown.
Binary file not shown.
115 changes: 40 additions & 75 deletions bitcoin_trading_simulation.py
Original file line number Diff line number Diff line change
@@ -1,25 +1,19 @@
import argparse
import numpy as np
import pandas as pd
import argparse

# UX Improvements: Colors for better readability


class Colors:
HEADER = '\033[95m'
BLUE = '\033[94m'
CYAN = '\033[96m'
GREEN = '\033[92m'
RED = '\033[91m'
WARNING = '\033[93m'
FAIL = '\033[91m'
ENDC = '\033[0m'
BOLD = '\033[1m'

@classmethod
def disable(cls):
cls.HEADER = ''
cls.BLUE = ''
cls.GREEN = ''
cls.RED = ''
cls.ENDC = ''
cls.BOLD = ''
UNDERLINE = '\033[4m'


def simulate_bitcoin_prices(days=60, initial_price=50000, volatility=0.02):
Expand All @@ -43,8 +37,10 @@ def calculate_moving_averages(prices, short_window=7, long_window=30):
"""
signals = pd.DataFrame(index=prices.index)
signals['price'] = prices
signals['short_mavg'] = prices.rolling(window=short_window, min_periods=1, center=False).mean()
signals['long_mavg'] = prices.rolling(window=long_window, min_periods=1, center=False).mean()
signals['short_mavg'] = prices.rolling(
window=short_window, min_periods=1, center=False).mean()
signals['long_mavg'] = prices.rolling(
window=long_window, min_periods=1, center=False).mean()
return signals


Expand All @@ -60,71 +56,58 @@ def generate_trading_signals(signals):
# A Death Cross (sell signal)
signals.loc[signals['short_mavg'] < signals['long_mavg'], 'signal'] = -1.0

# We create 'positions' to represent the trading action: 1 for buy, -1 for sell, 0 for hold
# We create 'positions' to represent the trading action: 1 for buy, -1 for
# sell, 0 for hold
signals['positions'] = signals['signal'].diff().shift(1)
return signals


def simulate_trading(signals, initial_cash=10000, quiet=False):
def simulate_trading(signals, initial_cash=10000):
"""
Simulates trading based on signals and prints a daily ledger.
Simulates trading based on signals and prints a ledger of trades.
"""
portfolio = pd.DataFrame(index=signals.index).fillna(0.0)
portfolio['price'] = signals['price']
portfolio['cash'] = float(initial_cash)
portfolio['btc'] = 0.0
portfolio['total_value'] = float(initial_cash)

if not quiet:
print(f"{Colors.HEADER}{Colors.BOLD}------ Daily Trading Ledger ------{Colors.ENDC}")
print(f"{Colors.HEADER}------ Daily Trading Ledger ------{Colors.ENDC}")
print(f"Simulating {len(signals)} days...")

for i, row in signals.iterrows():
if i > 0:
portfolio.loc[i, 'cash'] = portfolio.loc[i-1, 'cash']
portfolio.loc[i, 'btc'] = portfolio.loc[i-1, 'btc']
portfolio.loc[i, 'cash'] = portfolio.loc[i - 1, 'cash']
portfolio.loc[i, 'btc'] = portfolio.loc[i - 1, 'btc']

# Buy signal
if row['positions'] == 2.0:
btc_to_buy = portfolio.loc[i, 'cash'] / row['price']
portfolio.loc[i, 'btc'] += btc_to_buy
portfolio.loc[i, 'cash'] -= btc_to_buy * row['price']
if not quiet:
print(f"{Colors.GREEN}Day {i}: 💰 Buy {btc_to_buy:.4f} BTC at ${row['price']:.2f}{Colors.ENDC}")
print(f"{Colors.GREEN}Day {i}: 💰 Buy {btc_to_buy:.4f} BTC at ${row['price']:.2f}{Colors.ENDC}")

# Sell signal
elif row['positions'] == -2.0:
if portfolio.loc[i, 'btc'] > 0:
cash_received = portfolio.loc[i, 'btc'] * row['price']
amount_sold = portfolio.loc[i, 'btc']
cash_received = amount_sold * row['price']
portfolio.loc[i, 'cash'] += cash_received
if not quiet:
print(f"{Colors.RED}Day {i}: 📉 Sell {portfolio.loc[i, 'btc']:.4f} BTC at ${row['price']:.2f}{Colors.ENDC}")
print(f"{Colors.FAIL}Day {i}: 📉 Sell {amount_sold:.4f} BTC at ${row['price']:.2f}{Colors.ENDC}")
portfolio.loc[i, 'btc'] = 0

portfolio.loc[i, 'total_value'] = portfolio.loc[i, 'cash'] + portfolio.loc[i, 'btc'] * row['price']

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}")
portfolio.loc[i, 'total_value'] = portfolio.loc[i,
'cash'] + portfolio.loc[i, 'btc'] * row['price']
# Reduced noise: Commented out daily print
# 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 amount")
parser.add_argument("--initial-price", type=float, default=50000, help="Initial Bitcoin price")
parser.add_argument("--volatility", type=float, default=0.02, help="Price volatility")
parser.add_argument("--quiet", action="store_true", help="Suppress daily portfolio log")
parser.add_argument("--no-color", action="store_true", help="Disable colored output")

args = parser.parse_args()

if args.no_color:
Colors.disable()

def main():
# Simulate prices
prices = simulate_bitcoin_prices(days=args.days, initial_price=args.initial_price, volatility=args.volatility)
prices = simulate_bitcoin_prices()

# Calculate moving averages
signals = calculate_moving_averages(prices)
Expand All @@ -133,45 +116,27 @@ def simulate_trading(signals, initial_cash=10000, quiet=False):
signals = generate_trading_signals(signals)

# Simulate trading
portfolio = simulate_trading(signals, initial_cash=args.initial_cash, quiet=args.quiet)
portfolio = simulate_trading(signals)

# Final portfolio performance
final_value = portfolio['total_value'].iloc[-1]
initial_cash = args.initial_cash
initial_cash = 10000
profit = final_value - initial_cash

# Compare with buy and hold strategy
buy_and_hold_btc = args.initial_cash / prices.iloc[0]
buy_and_hold_btc = initial_cash / prices.iloc[0]
buy_and_hold_value = buy_and_hold_btc * prices.iloc[-1]

print(f"\n{Colors.HEADER}{Colors.BOLD}------ Final Portfolio Performance ------{Colors.ENDC}")
print(f"Initial Cash: ${args.initial_cash:.2f}")
print(f"Final Portfolio Value: ${final_value:.2f}")

if profit >= 0:
print(f"Profit/Loss: {Colors.GREEN}📈 ${profit:.2f}{Colors.ENDC}")
else:
print(f"Profit/Loss: {Colors.RED}📉 ${profit:.2f}{Colors.ENDC}")
profit_color = Colors.GREEN if profit >= 0 else Colors.FAIL

print(f"\n{Colors.HEADER}------ Final Portfolio Performance ------{Colors.ENDC}")
print(f"Initial Cash: ${initial_cash:.2f}")
print(f"Final Portfolio Value: ${final_value:.2f}")
print(
f"Profit/Loss: {profit_color}${profit:.2f}{Colors.ENDC}")
print(f"Buy and Hold Strategy Value: ${buy_and_hold_value:.2f}")
print(f"{Colors.HEADER}-----------------------------------------{Colors.ENDC}")


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 amount')
parser.add_argument('--initial-price', type=float, default=50000, help='Initial Bitcoin price')
parser.add_argument('--volatility', type=float, default=0.02, help='Volatility factor')
parser.add_argument('--quiet', action='store_true', help='Suppress daily output')
parser.add_argument('--no-color', action='store_true', help='Disable colored output')

args = parser.parse_args()

main(
days=args.days,
initial_price=args.initial_price,
volatility=args.volatility,
initial_cash=args.initial_cash,
quiet=args.quiet,
no_color=args.no_color
)
main()
2 changes: 0 additions & 2 deletions requirements.txt

This file was deleted.

Loading