Installation Guide
Requirements
- Python 3.8 or higher
- pip package manager
Basic Installation
Install Surfing Weights using pip:
This installs the core package with basic functionality.
Installation with Extra Features
Server Components
For running a weight streaming server:
This includes additional dependencies for: - FastAPI server - Monitoring capabilities - Server-side caching
Development Installation
For contributing to Surfing Weights or running tests:
This includes: - Testing frameworks - Development tools - Documentation dependencies
Full Installation
To install all optional dependencies:
Cloud Storage Support
Amazon S3
For S3 storage backend support:
Verifying Installation
Test your installation by running:
Next Steps
- Follow the Quick Start Guide to begin using Surfing Weights
- Learn about Core Concepts
- Explore Configuration Options