Skip to content

yohplala/halvix

Repository files navigation

Halvix

Cryptocurrency price analysis relative to Bitcoin halving cycles.

Halvix analyzes cryptocurrency performance across BTC halving cycles, comparing each coin's price action against the TOTAL2 market index (volume-weighted index of top altcoins).

Features

  • 📊 Retrieve and analyze top 1200 cryptocurrencies by market cap
  • 🔍 Filter out from download wrapped, staked, bridged tokens and stablecoins
  • 📉 Volume-weighted TOTAL2 index with 120-day SMA smoothing
  • 📈 Compare altcoins price performance across 2nd to 4th BTC halving cycles
  • 🎨 Interactive Plotly charts with normalized values
  • 🧩 Composition viewer to explore TOTAL2 makeup on any date

Quick Start

# Install
poetry install

# Fetch and filter coins
poetry run python -m main list-coins

# Fetch price data (BTC and USD)
poetry run python -m main fetch-prices

# Calculate TOTAL2 index
poetry run python -m main calculate-total2

# Generate interactive charts
poetry run python -m main generate-charts

# Check status
poetry run python -m main status

📖 See Tutorial for detailed step-by-step instructions.

Documentation

📊 Live Data & Charts

📋 References

  • AI Agent Context - Full project specification for AI agents and developers
  • Data Sources - CryptoCompare API details, rate limits, caching, data pipeline
  • TOTAL2 Calculation - How the TOTAL2 market index is calculated
  • Deployment - Charts generation and GitHub Pages deployment workflow
  • Changelog - Version history and release notes

Project Status

Module Status
Configuration ✅ Complete
Coin Filtering ✅ Complete
CryptoCompare Client ✅ Complete
Data Fetcher & Caching ✅ Complete
TOTAL2 Calculation ✅ Complete
GitHub Pages Docs ✅ Complete
Halving Cycle Charts ✅ Complete
Linear Regression ⏳ To implement

License

MIT

About

Review of BTC halving cycles

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •  

Languages