Skip to content

Commit 3e1f2a6

Browse files
committed
Fix: Markdown linting issues
- Add blank lines around headings and lists - Fix bare URLs in headings - Add trailing newlines to files - Comply with markdownlint standards
1 parent e37428c commit 3e1f2a6

3 files changed

Lines changed: 33 additions & 4 deletions

File tree

CHANGELOG.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
88
## [1.0.0] - 2025-01-06
99

1010
### Added
11+
1112
- Initial release of Aircraft Circle pattern detection system
1213
- Real-time circle pattern detection for training and holding patterns
1314
- Grid pattern detection for survey and search operations
@@ -24,6 +25,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2425
- Comprehensive documentation
2526

2627
### Features
28+
2729
- Circle Detection
2830
- Configurable radius range (0.5-10km default)
2931
- Minimum turn detection (1.5 turns default)
@@ -44,6 +46,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
4446
- Interactive controls
4547

4648
### Technical
49+
4750
- Python 3.8+ support
4851
- Flask web framework
4952
- Leaflet.js mapping
@@ -53,6 +56,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
5356
- CSV data persistence
5457

5558
### Documentation
59+
5660
- Comprehensive README
5761
- Docker deployment guide
5862
- Configuration reference
@@ -64,11 +68,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
6468
## Future Releases
6569

6670
### [Planned Features]
71+
6772
- Additional pattern types (figure-8, racetrack)
6873
- Email/webhook notifications
6974
- Pattern statistics dashboard
7075
- Machine learning pattern prediction
7176
- Multi-language support
7277
- Mobile responsive design
7378
- API endpoints for integration
74-
- Prometheus metrics export
79+
- Prometheus metrics export

CONTRIBUTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ Thank you for your interest in contributing to Aircraft Circle! This document pr
55
## Code of Conduct
66

77
By participating in this project, you agree to abide by our code of conduct:
8+
89
- Be respectful and inclusive
910
- Welcome newcomers and help them get started
1011
- Focus on constructive criticism
@@ -52,13 +53,15 @@ pip install black flake8 pytest
5253
#### Development Workflow
5354

5455
1. Create a feature branch:
56+
5557
```bash
5658
git checkout -b feature/your-feature-name
5759
```
5860

5961
2. Make your changes following our coding standards
6062

6163
3. Test your changes:
64+
6265
```bash
6366
# Run the application
6467
python app.py --test
@@ -71,12 +74,14 @@ pip install black flake8 pytest
7174
```
7275

7376
4. Commit your changes:
77+
7478
```bash
7579
git add .
7680
git commit -m "Add: brief description of changes"
7781
```
7882

7983
5. Push to your fork:
84+
8085
```bash
8186
git push origin feature/your-feature-name
8287
```
@@ -114,6 +119,7 @@ def calculate_circle_radius(positions: List[Position]) -> float:
114119
### Commit Messages
115120

116121
Use clear, descriptive commit messages:
122+
117123
- `Add: new feature description`
118124
- `Fix: bug description`
119125
- `Update: component description`
@@ -230,6 +236,7 @@ docker buildx build \
230236
## Recognition
231237

232238
Contributors will be recognized in:
239+
233240
- README.md acknowledgments
234241
- Release notes
235242
- Project documentation

README.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,22 @@ Real-time aircraft pattern detection system that monitors TAR1090 feeds to ident
1111
## 🎯 Features
1212

1313
### Pattern Detection
14+
1415
- **Circle Detection**: Identifies aircraft flying in circular patterns (training, holding, orbits)
1516
- **Grid Detection**: Detects survey/search grid patterns, mapping flights, and search & rescue operations
1617
- **Real-time Monitoring**: Continuously analyzes aircraft movements from TAR1090 data feeds
1718
- **Historical Tracking**: Maintains comprehensive logs of all detected patterns with TAR1090 replay links
1819

1920
### Web Interface
21+
2022
- **Live Map View**: Real-time visualization of aircraft and detected patterns
2123
- **TAR1090-style Icons**: Aircraft displayed with type-appropriate icons and altitude-based coloring
2224
- **Track History**: Flight path visualization with altitude-based color coding
2325
- **Pattern History Page**: Browse and filter all historical pattern detections
2426
- **Interactive Controls**: Toggle aircraft display, tracks, and pattern overlays
2527

2628
### Data & Integration
29+
2730
- **CSV Logging**: Automatic logging of all detections for analysis
2831
- **TAR1090 Integration**: Direct links to view patterns in TAR1090 with proper time ranges
2932
- **Multi-source Support**: Works with any TAR1090-compatible data source
@@ -94,27 +97,35 @@ python app.py --server http://your-tar1090:8080 --web
9497
### Detection Parameters
9598

9699
#### Circle Detection
100+
97101
| Variable | Description | Default |
98102
|----------|-------------|---------|
99103
| `MIN_RADIUS` | Minimum circle radius (km) | `0.5` |
100104
| `MAX_RADIUS` | Maximum circle radius (km) | `10` |
101105
| `MIN_TURNS` | Minimum number of turns | `1.5` |
102106

103107
#### Grid Detection
108+
104109
| Variable | Description | Default |
105110
|----------|-------------|---------|
106111
| `MIN_GRID_LEGS` | Minimum parallel legs | `3` |
107112
| `MIN_LEG_LENGTH` | Minimum leg length (km) | `2.0` |
108113

109114
## 🖥️ Web Interface
110115

111-
### Live View (http://localhost:8888)
116+
### Live View
117+
118+
Access at: `http://localhost:8888`
119+
112120
- Real-time aircraft positions with TAR1090-style icons
113121
- Live pattern detection with visual overlays
114122
- Interactive controls for display options
115123
- Auto-centering on new pattern detections
116124

117-
### History View (http://localhost:8888/history)
125+
### History View
126+
127+
Access at: `http://localhost:8888/history`
128+
118129
- Browse all historical pattern detections
119130
- Filter by date range, pattern type, and callsign
120131
- Visual timeline of detection activity
@@ -124,12 +135,14 @@ python app.py --server http://your-tar1090:8080 --web
124135
## 📊 Data Output
125136

126137
### CSV Files
138+
127139
Pattern detections are automatically logged to CSV files in the data directory:
128140

129141
- `circle_detections.csv` - All circular pattern detections
130142
- `grid_detections.csv` - All grid pattern detections
131143

132144
### CSV Fields
145+
133146
- Timestamp, Aircraft ID, Callsign
134147
- Pattern characteristics (radius, turns, coverage area)
135148
- Position data (center lat/lon)
@@ -139,7 +152,9 @@ Pattern detections are automatically logged to CSV files in the data directory:
139152
## 🐳 Docker Deployment
140153

141154
### Multi-Architecture Support
155+
142156
The container supports multiple architectures:
157+
143158
- `linux/amd64` - Standard x86-64
144159
- `linux/arm64` - 64-bit ARM (Raspberry Pi 4, etc.)
145160
- `linux/arm/v7` - 32-bit ARM
@@ -201,13 +216,15 @@ Options:
201216
## 📈 Pattern Detection Logic
202217

203218
### Circle Detection Algorithm
219+
204220
1. Analyzes aircraft track points to identify curved paths
205221
2. Calculates center point and radius of potential circles
206222
3. Counts completed turns (360° rotations)
207223
4. Validates against minimum radius and turn requirements
208224
5. Logs detection with TAR1090 replay link
209225

210226
### Grid Detection Algorithm
227+
211228
1. Identifies parallel flight segments
212229
2. Analyzes heading changes between legs
213230
3. Validates grid spacing and coverage area
@@ -249,4 +266,4 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
249266

250267
---
251268

252-
Made with ❤️ for the aviation and SDR community
269+
Made with ❤️ for the aviation and SDR community

0 commit comments

Comments
 (0)