Skip to content

moose25/Rayfall

Repository files navigation

RayfallLogo

Rayfall: QRZ Logbook Map Viewer

Rayfall is a dynamic ham radio mapping interface that pulls your logbook data from QRZ and plots your QSOs on an interactive Leaflet map. You can explore contacts by date range, filter by band and mode, and visually analyze your contacts across different locations and timeframes.

Built by N2CLW

Available at rayfall.me


Features

  • Interactive Leaflet Map
  • Multiple import methods:
    • QRZ API integration (supports multiple logbooks)
    • NEW: ADI/ADIF file import (no API key required!)
  • Date range selection
  • Color-coded pins by band
  • Customizable display options:
    • Multiple pin icon styles (teardrop, circle, square, star)
    • Selectable QTH station icons (⚡📍🏠📡🗼⭐)
    • Custom grid square colors and opacity
    • Multiple basemap styles
  • Grid square overlay with 4/6-character precision
  • Map lines to QSOs (toggle on/off)
  • Filter QSOs by band and mode
  • High-resolution map export (300 DPI for printing)
  • Auto-reads your QTH from log data
  • Clean dropdown menu for display options
  • Works offline with ADI files

Screenshot

RayfallScreenshot


Installation

Prerequisites

  • Python 3.11+
  • pip
  • Git

1. Clone the Repository

git clone https://github.com/moose25/rayfall.git
cd rayfall

2. Set Up a Virtual Environment

python3 -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

3. Install Dependencies

pip install -r requirements.txt

Note: Required packages include FastAPI, uvicorn, and Jinja2. You can also install them manually:

pip install fastapi uvicorn jinja2

4. Start the Server

uvicorn main:app --reload

This starts the server locally at: http://127.0.0.1:8000


Usage Instructions

Getting Started

New users? Click the "📖 How to Use Rayfall" button (top-right) for interactive tutorials!

Method 1: QRZ API (Online)

  1. Visit http://127.0.0.1:8000 in your browser.
  2. Click the "Change API Key" button in the top-right.
  3. Paste in your QRZ Logbook API key and click Save.
  4. Choose a start and end date and click Load from QRZ.
  5. Filter contacts by band/mode and customize display options.

Method 2: ADI File Import (Offline) 🆕

  1. Visit http://127.0.0.1:8000 in your browser.
  2. Click "Import ADI File" and select your .adi or .adif file.
  3. Your QSOs load instantly - no API key needed!
  4. Filter contacts by band/mode and customize display options.

See QUICK_START_ADI.md for detailed ADI import guide.

Display Customization 🆕

Click the "⚙️ Display Options" button to access:

  • Map Style: Light, Dark, Topographic, Satellite, Streets
  • QTH Icon: Choose from 6 different station icons
  • Pin Style: Teardrop, Circle, Square, or Star markers
  • Grid Squares: Custom colors, opacity, and precision (4 or 6 chars)

All contacts with grid squares or lat/lon information will be plotted.

Need Help?

The "📖 How to Use Rayfall" button provides:

  • Step-by-step setup instructions
  • ADI import guide for all major logging software
  • Display customization tutorials
  • Filtering and export tips
  • Pro tips for advanced usage

✅ You can switch logbooks anytime by clicking the API Key button again.


QRZ API Key Info

Rayfall does not store your API key on a server. Instead:

  • It saves it to localStorage in your browser.
  • The backend reads the key from request headers.
  • No secret is ever exposed in the source code.

🔐 This makes it safe to share or host this code publicly.

To generate a QRZ Logbook API Key:

  1. Go to https://logbook.qrz.com/
  2. Click on Settings > API
  3. Copy your unique API key

Customization

Change the Default Map Location

Rayfall centers on VA by default. Once a valid log is loaded, it updates to your actual QTH using your first valid my_lat and my_lon from the QRZ logs.

If you'd like to hardcode a default starting location, edit:

map = L.map('map').setView([XXX, XXX], 4);

Styling

Edit the styles directly in the <style> block inside index.html. All controls and map elements can be styled using standard CSS.


Directory Structure

rayfall/
├── main.py                 # FastAPI backend
├── templates/
│   └── index.html          # Frontend map UI
├── static/
│   ├── rayfall.png         # Logo
│   └── screenshot.png      # Screenshot
├── requirements.txt        # Python dependencies
└── README.md               # You're reading this

Contributing

Pull requests and forks are welcome! If you find a bug or want to suggest a feature, feel free to open an issue or PR.


License

This project is open source and available under the MIT License.


Created by

Chris Williams (N2CLW)


73 and happy DXing!

About

Plot your ham radio QSOs from a QRZ logbook on an interactive map. Filter by date, band, and mode; import via the QRZ API or an ADIF file.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors