Skip to content
Open
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
14 changes: 7 additions & 7 deletions docs/CLAUDE.md → CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,10 @@ The HamSCI Contesting and DXing Dashboard is a real-time web application designe

### Key Documents

- [docs/REQUIREMENTS.md](REQUIREMENTS.md) - Formal requirements specification (primary reference)
- [README.md](../README.md) - Complete technical documentation
- [OPERATOR_GUIDE.md](../OPERATOR_GUIDE.md) - User guide for radio operators
- [CONTRIBUTING.md](../CONTRIBUTING.md) - Developer contribution guidelines
- [docs/REQUIREMENTS.md](docs/REQUIREMENTS.md) - Formal requirements specification (primary reference)
- [README.md](README.md) - Complete technical documentation
- [OPERATOR_GUIDE.md](OPERATOR_GUIDE.md) - User guide for radio operators
- [CONTRIBUTING.md](CONTRIBUTING.md) - Developer contribution guidelines
- [HamSCI Workshop 2025 Poster](references/Ruzankski,%20Owen%20-%20FRC_W3USR_POSTER%20-%20HamSCI%20Workshop%202025.pdf) - Project overview and goals
- [FRC Proposal](references/20250123%20FRC%20Proposal.pdf) - Detailed project proposal

Expand Down Expand Up @@ -184,7 +184,7 @@ When modifying [docs/REQUIREMENTS.md](REQUIREMENTS.md):
### On First Message

1. Read [docs/REQUIREMENTS.md](REQUIREMENTS.md) to understand the project
2. Read [docs/CLAUDE.md](CLAUDE.md) (this file) to understand the AI contribution history
2. Read [CLAUDE.md](CLAUDE.md) (this file) to understand the AI contribution history
3. Check `git log` to see recent changes
4. Ask the user what they would like to work on

Expand Down Expand Up @@ -457,7 +457,7 @@ For questions about this project or the use of AI assistance, please refer to th
- Updated `templates/index_ft.html` and `templates/index_wcount.html`: replaced `https://unpkg.com/leaflet/...` with `vendor/leaflet/...`
- Updated `README.md` and `docs/CLAUDE.md`

**Note**: `static/vendor/` is not git-tracked. Re-run the download commands in README.md → "Offline Basemap Files" and "Leaflet Vendor Files" sections after any `git clean` or fresh clone.
**Note**: `static/vendor/` and GeoJSON files are git-tracked and included in the repository. No separate download is needed after a fresh clone.

**Files Modified**:
- `static/vendor/leaflet/` — new directory (leaflet.js, leaflet.css, images/)
Expand Down Expand Up @@ -647,7 +647,7 @@ This documentation file is part of the HamSCI Contesting and DXing Dashboard pro
**Recommended Citation Format**:
```
This project was developed with assistance from Claude (Anthropic) AI assistant.
See docs/CLAUDE.md for detailed contribution history.
See CLAUDE.md for detailed contribution history.
```

---
Expand Down
20 changes: 10 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ Before contributing, ensure you have:

1. **Clone the repository:**
```bash
git clone https://github.com/hamsci/contesting-dashboard.git
cd contesting-dashboard
git clone https://github.com/HamSCI/frc_contesting.git
cd frc_contesting
```

2. **Create virtual environment:**
Expand Down Expand Up @@ -171,7 +171,7 @@ def fetch_wspr_spots(lastInterval=15):

# Variables: lowercase with underscores
spot_count = 0
rx_callsign = "KD3ALD"
rx_callsign = "W3USR"

# Constants: UPPERCASE with underscores
CONTEST_BANDS = ["160m", "80m", "40m", "20m", "15m", "10m"]
Expand Down Expand Up @@ -247,7 +247,7 @@ function loadSpots() {

// Variables: camelCase
let spotCount = 0;
const rxCallsign = "KD3ALD";
const rxCallsign = "W3USR";

// Constants: SCREAMING_SNAKE_CASE
const CONTEST_BANDS = ["160m", "80m", "40m", "20m", "15m", "10m"];
Expand Down Expand Up @@ -440,8 +440,8 @@ If you'd like to help set up testing infrastructure, please reach out!
3. Screenshots (if UI changes)

**When using AI assistance (Claude, etc.):**
1. Review [docs/CLAUDE.md](docs/CLAUDE.md) for project context and guidelines
2. Update docs/CLAUDE.md session history if making significant contributions
1. Review [CLAUDE.md](CLAUDE.md) for project context and guidelines
2. Update CLAUDE.md session history if making significant contributions
3. Follow the offline-first constraints (no CDN dependencies)
4. Reference requirement IDs when implementing features

Expand Down Expand Up @@ -572,7 +572,7 @@ If applicable, add screenshots
## Environment
- Browser: [e.g., Chrome 120]
- OS: [e.g., Windows 11]
- Dashboard URL: [e.g., http://dash.kd3ald.com]
- Dashboard URL: [e.g., http://192.168.1.100:5000]
- Time of occurrence: [e.g., 2026-01-07 14:30 UTC]

## Additional Context
Expand Down Expand Up @@ -661,7 +661,7 @@ For technical questions, feel free to open a discussion or contact the maintaine
### Project Documentation

- [docs/REQUIREMENTS.md](docs/REQUIREMENTS.md) - Formal requirements specification
- [docs/CLAUDE.md](docs/CLAUDE.md) - AI assistance history and guidelines
- [CLAUDE.md](CLAUDE.md) - AI assistance history and guidelines
- [README.md](README.md) - Complete technical documentation
- [OPERATOR_GUIDE.md](OPERATOR_GUIDE.md) - User guide for operators

Expand Down Expand Up @@ -700,7 +700,7 @@ Contributors will be recognized in:

## License

By contributing to this project, you agree that your contributions will be licensed under the same license as the project (to be determined - likely MIT or GPL).
By contributing to this project, you agree that your contributions will be licensed under the GNU General Public License v3.0.

---

Expand All @@ -722,4 +722,4 @@ Bud Trench, AA3B

**Thank you for contributing to HamSCI and advancing amateur radio science!**

*73 de KD3ALD*
*73 de HamSCI*
38 changes: 19 additions & 19 deletions OPERATOR_GUIDE.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
# HamSCI Contesting Dashboard - Operator Quick Reference

**Station:** KD3ALD Personal Space Weather Station
**Location:** FN21ni (Northern New Jersey)
**Dashboard:** http://dash.kd3ald.com
> **Note for station operators:** This guide is a template. Replace `YOUR_CALLSIGN`, `YOUR_GRID`, and `http://YOUR_DASHBOARD_URL` throughout with your station's actual callsign, Maidenhead grid square, and dashboard URL.

**Station:** YOUR_CALLSIGN Personal Space Weather Station
**Location:** YOUR_GRID
**Dashboard:** http://YOUR_DASHBOARD_URL

---

## Quick Start

### What This Dashboard Shows

This dashboard displays **real-time HF propagation conditions** by showing decoded WSPR, FT8, and FT4 spots from the KD3ALD receiver. Each spot represents a successful digital mode reception, indicating that a particular band is open to that location.
This dashboard displays **real-time HF propagation conditions** by showing decoded WSPR, FT8, and FT4 spots from your receiver. Each spot represents a successful digital mode reception, indicating that a particular band is open to that location.

**Use this dashboard to answer:**
- ✅ What bands are currently open?
Expand Down Expand Up @@ -154,7 +156,7 @@ Amateur radio contest zones (1-40) defined by CQ Magazine. Used for zone multipl
**Example Zones:**
- Zone 3: West Coast USA
- Zone 4: Central USA
- Zone 5: East Coast USA (includes KD3ALD receiver)
- Zone 5: East Coast USA
- Zone 14-16, 20: Europe
- Zone 25: Japan

Expand Down Expand Up @@ -320,11 +322,11 @@ Europe spots (last 15 min):

---

## Understanding Your Receiver (KD3ALD PSWS)
## Understanding Your Receiver (YOUR_CALLSIGN PSWS)

### What the Receiver Does

The Personal Space Weather Station at KD3ALD **continuously monitors all HF bands** using:
The Personal Space Weather Station at YOUR_CALLSIGN **continuously monitors all HF bands** using:
- **RX-888 MkII SDR** (software defined radio)
- **30 MHz bandwidth** (covers 0.3-30 MHz simultaneously!)
- **KA9Q-radio software** (multichannel receiver)
Expand All @@ -333,7 +335,7 @@ The Personal Space Weather Station at KD3ALD **continuously monitors all HF band

### Data Collection

**Receiver location:** FN21ni grid square (Northern New Jersey)
**Receiver location:** YOUR_GRID grid square

**What it decodes:**
- WSPR on all amateur bands (2200m through 6m)
Expand All @@ -354,13 +356,13 @@ The Personal Space Weather Station at KD3ALD **continuously monitors all HF band
### Receiver Limitations

**Important to know:**
- ⚠️ **One receiver only:** Dashboard shows propagation **TO** KD3ALD (FN21ni)
- ⚠️ **Not transmitting:** KD3ALD receiver is RX-only (doesn't transmit)
- ⚠️ **One receiver only:** Dashboard shows propagation **TO** YOUR_CALLSIGN (YOUR_GRID)
- ⚠️ **Not transmitting:** YOUR_CALLSIGN receiver is RX-only (doesn't transmit)
- ⚠️ **Local noise:** Urban QTH may have higher noise floor
- ⚠️ **Antenna limitations:** Small active antenna (not a beam or large wire)

**What this means for you:**
- **Dashboard shows:** What stations can hear at KD3ALD location
- **Dashboard shows:** What stations can hear at YOUR_CALLSIGN location
- **Dashboard doesn't show:** What you'll hear at YOUR location
- **But:** HF propagation is generally reciprocal, so it's a good indicator!

Expand All @@ -383,7 +385,7 @@ Use this dashboard as a **guide** for band conditions, but always verify with yo

**Solutions:**
1. **Clear browser cache:** Ctrl+F5 (Windows) or Cmd+Shift+R (Mac)
2. **Check internet connection:** GeoJSON files are large (~18MB)
2. **Check browser console:** Open DevTools (F12) and look for loading errors
3. **Try different browser:** Chrome, Firefox, or Edge
4. **Disable browser extensions:** Some ad blockers interfere with maps

Expand Down Expand Up @@ -468,16 +470,14 @@ Shows **actual measured propagation** from your local region, not predictions or
## Contact and Support

**Dashboard Operator:**
Owen Ruzanski, KD3ALD
Email: owen.ruzanski@scranton.edu
YOUR_CALLSIGN
[Your contact information]

**Receiver Station:**
KD3ALD, Grid FN21ni
Northern New Jersey, USA
YOUR_CALLSIGN, Grid YOUR_GRID

**Project Website:**
University of Scranton W3USR Amateur Radio Club
HamSCI Personal Space Weather Station Project
HamSCI Personal Space Weather Station Project — https://hamsci.org/

**Report Issues:**
- Receiver offline
Expand All @@ -499,6 +499,6 @@ HamSCI Personal Space Weather Station Project

---

**73 de KD3ALD - Good DX!**
**73 de YOUR_CALLSIGN - Good DX!**

*For technical documentation, see [README.md](README.md)*
Loading