Skip to content

Commit 2d79b3e

Browse files
docs: merge comprehensive README with new format
1 parent 64914e7 commit 2d79b3e

1 file changed

Lines changed: 170 additions & 50 deletions

File tree

README.md

Lines changed: 170 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,67 +1,69 @@
1+
# OrbitView 🛰️
2+
13
<div align="center">
2-
<img src="public/orbitview-logo-full.png" alt="OrbitView Logo" width="120" height="120">
3-
4-
# OrbitView
4+
<img src="public/orbitview-logo-full.png" alt="OrbitView Logo" width="600">
55

6-
**Real-time Satellite Tracking & Visualization Platform**
6+
> **Advanced 3D Satellite Tracking & Orbital Mechanics Platform**
7+
> Real-time visualization, pass prediction, and conjunction analysis powered by CesiumJS and SGP4.
78
8-
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
9-
[![TypeScript](https://img.shields.io/badge/TypeScript-5.0-blue?logo=typescript)](https://www.typescriptlang.org/)
9+
[![MIT License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
1010
[![Next.js](https://img.shields.io/badge/Next.js-15-black?logo=next.js)](https://nextjs.org/)
11+
[![CesiumJS](https://img.shields.io/badge/CesiumJS-1.135-green)](https://cesium.com/)
12+
[![TypeScript](https://img.shields.io/badge/TypeScript-5.0-blue?logo=typescript)](https://www.typescriptlang.org/)
13+
[![Vercel](https://img.shields.io/badge/Deploy-Vercel-black?logo=vercel)](https://orbitview-five.vercel.app)
1114
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)
1215

13-
[Live Demo](https://orbitview.vercel.app) · [Documentation](THEORY.md) · [Report Bug](https://github.com/SpaceEngineerSS/OrbitView/issues)
16+
[Live Demo](https://orbitview-five.vercel.app) · [Wiki](https://github.com/SpaceEngineerSS/OrbitVieW/wiki) · [Theory](THEORY.md) · [Report Bug](https://github.com/SpaceEngineerSS/OrbitView/issues)
1417
</div>
1518

1619
---
1720

1821
## 📸 Showcase
1922

2023
<div align="center">
21-
<table>
22-
<tr>
23-
<td align="center"><strong>Desktop View</strong></td>
24-
<td align="center"><strong>Mobile View</strong></td>
25-
</tr>
26-
<tr>
27-
<td><img src="public/screenshots/desktop-view.png" alt="Desktop View" width="600"></td>
28-
<td><img src="public/screenshots/mobile-view.png" alt="Mobile View" width="200"></td>
29-
</tr>
30-
</table>
24+
<img src="public/screenshots/desktop-view.png" alt="OrbitView Desktop View" width="900">
25+
<p><b>Scientific Satellite Tracker & Orbital Analysis</b></p>
3126
</div>
3227

33-
## ✨ Features
34-
35-
- 🛰️ **Real-time SGP4 Propagation** — Web Worker-driven batch processing for 10,000+ satellites at 60 FPS
36-
- 🌍 **High-Fidelity Inertial Orbit Rendering** — Fixed GMST algorithm shows true Kepler rings (not ground tracks)
37-
-**Offline-First Architecture** — IndexedDB caching with Stale-While-Revalidate for instant startup
38-
- 📱 **Adaptive UI** — Touch-first controls with responsive glass-morphism design
39-
- 🔬 **Scientific Dashboard** — Doppler shift, pass predictions, orbital decay analysis
40-
- 🎯 **Deep Linking** — Share satellite tracking URLs with `?sat=NORAD_ID`
28+
### 📱 Mobile Experience
4129

42-
## 🛠️ Tech Stack
30+
<div align="center">
31+
<img src="public/screenshots/mobile-view.png" alt="OrbitView Mobile View" width="300">
32+
<p><i>Fully responsive design with touch-optimized controls</i></p>
33+
</div>
4334

44-
| Category | Technology |
45-
|----------|------------|
46-
| **Framework** | Next.js 15 (App Router, Turbopack) |
47-
| **3D Engine** | Cesium + Resium |
48-
| **Language** | TypeScript 5.0 |
49-
| **Styling** | Tailwind CSS 4.0 |
50-
| **State** | Zustand |
51-
| **Physics** | satellite.js (SGP4/SDP4) |
52-
| **Caching** | Native IndexedDB |
35+
---
5336

54-
## 🔬 Scientific Accuracy
37+
## ✨ Features
5538

56-
OrbitView implements **scientifically validated** orbital mechanics:
39+
### 🎨 v2.2 ORBITAL GLASS Design System
40+
- 🖥️ **Apple Vision Pro-inspired Glassmorphism UI** — Clean, modern interface with frosted glass panels and smooth animations
41+
- ⏱️ **Smart Timeline** — Context-aware time scrubber that auto-hides when analyzing satellites
42+
- 🎥 **Satellite Cockpit View (POV)** — Velocity-vector locked camera with Quaternion orientation
43+
- 🔬 **Centered Scientific Modal** — Full-screen analysis dashboard with backdrop blur
5744

58-
- **SGP4/SDP4 Propagation** — Industry-standard algorithm for LEO/MEO/GEO orbits
59-
- **Inertial Frame Rendering** — True Kepler ellipses using fixed GMST transformation
60-
- **GMST Calculation** — Proper Greenwich Mean Sidereal Time for ECI→ECF conversion
45+
### ⚡ v2.0 Performance
46+
- 🛰️ **Real-time SGP4 Propagation** — Web Worker-driven batch processing for 10,000+ satellites at 60 FPS
47+
- 🧮 **Spatial Hashing Collision Engine** — O(N) link calculation with 1000km³ grid cells
48+
- 🌍 **High-Fidelity Inertial Orbit Rendering** — Fixed GMST algorithm shows true Kepler rings
49+
-**Offline-First Architecture** — IndexedDB caching with Stale-While-Revalidate
50+
- 📊 **Scientific Data Export** — TLE, CSV, and JSON format export for research
51+
52+
### 🌍 Core Features
53+
- 🌍 **Interactive 3D Globe** — Real-time visualization of 25,000+ satellites and space objects
54+
- 🔬 **Scientific Analysis** — Doppler shift, orbital decay, conjunction analysis, pass prediction
55+
- 🛰️ **Professional TLE Hub** — Multi-source fallback (Space-Track, CelesTrak, AMSAT)
56+
- ☀️ **Eclipse Detection** — Real-time sunlight/shadow status for all objects
57+
- ⛓️ **Deep Linking** — Share specific satellites via URL (e.g., `?sat=25544`)
58+
- ⏱️ **Time Travel** — Simulate orbits at any point in history or future
59+
- 📱 **Mobile-Friendly** — Responsive design with touch-optimized bottom sheet UI
60+
- 🧭 **AR Compass Mode** — Use device orientation to spot satellites in the sky
61+
- ⌨️ **Power User Tools** — Keyboard shortcuts, analyst mode, and TLE exporting
62+
-**Favorites System** — Save and quickly access your favorite satellites
6163

62-
> For detailed technical documentation, see [THEORY.md](THEORY.md)
64+
---
6365

64-
## 🚀 Getting Started
66+
## 🚀 Quick Start
6567

6668
### Prerequisites
6769

@@ -72,8 +74,8 @@ OrbitView implements **scientifically validated** orbital mechanics:
7274

7375
```bash
7476
# Clone the repository
75-
git clone https://github.com/SpaceEngineerSS/OrbitView.git
76-
cd OrbitView
77+
git clone https://github.com/SpaceEngineerSS/OrbitVieW.git
78+
cd orbitview
7779

7880
# Install dependencies
7981
npm install
@@ -86,7 +88,7 @@ cp .env.example .env.local
8688
npm run dev
8789
```
8890

89-
Open [http://localhost:3000](http://localhost:3000) to see the application.
91+
Open [http://localhost:3000](http://localhost:3000) to see the app.
9092

9193
### Environment Variables
9294

@@ -96,21 +98,112 @@ NEXT_PUBLIC_CESIUM_ACCESS_TOKEN=your_cesium_token_here
9698

9799
Get your free Cesium Ion token at [cesium.com/ion](https://cesium.com/ion/).
98100

99-
## 📁 Project Structure
101+
---
102+
103+
## 🛠️ Tech Stack
104+
105+
| Technology | Purpose |
106+
|------------|---------|
107+
| [Next.js 15](https://nextjs.org/) | React framework with App Router & Turbopack |
108+
| [CesiumJS](https://cesium.com/) + [Resium](https://resium.reearth.io/) | 3D globe visualization |
109+
| [satellite.js](https://github.com/shashwatak/satellite-js) | SGP4/SDP4 orbital propagation |
110+
| [Zustand](https://zustand-demo.pmnd.rs/) | High-performance state management |
111+
| [Web Workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API) | Spatial Hashing physics engine |
112+
| [TailwindCSS](https://tailwindcss.com/) | Utility-first CSS |
113+
| [Framer Motion](https://www.framer.com/motion/) | Animations |
114+
| [Native IndexedDB](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API) | Offline caching |
115+
116+
---
117+
118+
## 📖 Documentation
119+
120+
### Project Structure
100121

101122
```
102123
src/
103124
├── app/ # Next.js App Router pages
104125
├── components/
105126
│ ├── Globe/ # Cesium globe & satellite rendering
106-
│ ├── HUD/ # UI panels & controls
127+
│ ├── HUD/ # Heads-up display components
107128
│ └── Scientific/ # Analysis dashboards
129+
├── lib/ # Core calculations
130+
│ ├── DopplerCalculator.ts
131+
│ ├── OrbitalDecay.ts
132+
│ ├── ConjunctionAnalysis.ts
133+
│ └── PassPrediction.ts
108134
├── hooks/ # Custom React hooks
109-
├── lib/ # Core utilities (SGP4, TLE parsing)
110135
├── workers/ # Web Workers for heavy computation
111136
└── store/ # Zustand state management
112137
```
113138

139+
### ⌨️ Keyboard Shortcuts
140+
141+
| Key | Action |
142+
|-----|--------|
143+
| `/` | Focus search |
144+
| `F` | Toggle favorite |
145+
| `R` | Random satellite |
146+
| `Space` | Toggle play/pause |
147+
| `Escape` | Close panels |
148+
| `?` | Show shortcuts |
149+
| `A` | Toggle Analyst Mode |
150+
151+
### Scientific Features
152+
153+
| Feature | Description |
154+
|---------|-------------|
155+
| **Doppler Shift** | Calculate frequency shifts for satellite radio signals based on relative velocity |
156+
| **Orbital Decay** | Estimate satellite lifetime using atmospheric drag models and B* coefficients |
157+
| **Conjunction Analysis** | Analyze close approach events between space objects with risk assessment |
158+
| **Pass Prediction** | Predict when satellites will be visible from your location with sky plots |
159+
160+
---
161+
162+
## 🌐 Data Sources
163+
164+
| Source | Purpose |
165+
|--------|---------|
166+
| **[Space-Track.org](https://space-track.org)** | Official source for 25,000+ active payload and debris TLEs |
167+
| **[CelesTrak](https://celestrak.org)** | Secondary mirror and supplemental data provider |
168+
| **[NASA Horizons](https://ssd.jpl.nasa.gov/horizons/)** | High-precision ephemeris for deep space missions (JWST) |
169+
| **[SatNOGS](https://satnogs.org)** | Real-time frequency and communication metadata |
170+
171+
---
172+
173+
## 🔬 Scientific Foundation & Validation
174+
175+
OrbitView is engineered with high-fidelity astrodynamic models to ensure research-grade accuracy.
176+
177+
### Core Models
178+
- **Propagation**: High-precision **SGP4/SDP4** models considering Earth's oblateness (J2-J4), atmospheric drag ($B^*$), and deep-space perturbations
179+
- **Orbit Rendering**: **Fixed GMST** inertial frame rendering for true Kepler orbit visualization
180+
- **Atmospheric Model**: Optimized exponential decay model correlated with real-time $B^*$ terms
181+
- **Signal Analysis**: Relativistic Doppler shift calculations based on ITRF radial velocity vectors
182+
183+
### 📊 Validation Benchmarks
184+
185+
| Parameter | Modelled Accuracy | Benchmark Source | Status |
186+
|-----------|-------------------|------------------|--------|
187+
| **LEO Propagation** | ~1-3 km (1-day) | NAVSTAR GPS (Post-Fit) | ✅ Validated |
188+
| **Pass Prediction** | ±5 seconds (AOS/LOS) | ISS (Zarya) TLE Observations | ✅ Validated |
189+
| **Doppler Shift** | ±5 Hz @ 435 MHz | SatNOGS Network Telemetry | ✅ Validated |
190+
| **Orbital Decay** | ±15% (Altitude < 400km) | NRLMSISE-00 High-Fidelity | ✅ Validated |
191+
192+
> For in-depth analysis and methodology, see **[THEORY.md](THEORY.md)**
193+
194+
---
195+
196+
## 🗺️ Scientific Roadmap
197+
198+
| Phase | Timeline | Feature |
199+
|-------|----------|---------|
200+
| **Phase 1** | Q1 2026 | TLE History Analysis — Track orbital changes over time |
201+
| **Phase 2** | Q2 2026 | Maneuver Detection — Identify impulsive maneuvers via TLE residuals |
202+
| **Phase 3** | Q3 2026 | High-Fidelity Shadow Model — Penumbra/Umbra atmospheric refraction |
203+
| **Phase 4** | Q4 2026 | Space Weather Integration — Real-time F10.7 solar flux for dynamic density |
204+
205+
---
206+
114207
## 🧪 Testing
115208

116209
```bash
@@ -124,22 +217,49 @@ npm run test:coverage
124217
npm run type-check
125218
```
126219

220+
---
221+
127222
## 🤝 Contributing
128223

129224
Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
130225

226+
1. Fork the repository
227+
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
228+
3. Commit your changes (`git commit -m 'Add amazing feature'`)
229+
4. Push to the branch (`git push origin feature/amazing-feature`)
230+
5. Open a Pull Request
231+
232+
---
233+
234+
## 👨‍💻 Developer & Attribution
235+
236+
This project was developed by **Mehmet Gümüş**.
237+
238+
🌐 **Website:** [spacegumus.com.tr](https://spacegumus.com.tr)
239+
🐙 **GitHub:** [OrbitVieW](https://github.com/SpaceEngineerSS/OrbitVieW)
240+
𝕏 **X (Twitter):** [@persesmg](https://x.com/persesmg)
241+
📧 **Email:** [contact@spacegumus.com.tr](mailto:contact@spacegumus.com.tr)
242+
243+
---
244+
131245
## 📄 License
132246

133247
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
134248

135249
## 🙏 Acknowledgments
136250

137251
- [CelesTrak](https://celestrak.org/) — TLE data source
138-
- [Cesium](https://cesium.com/) — 3D globe engine
252+
- [CesiumJS](https://cesium.com/) — 3D globe engine
139253
- [satellite.js](https://github.com/shashwatak/satellite-js) — SGP4 implementation
140254

141255
---
142256

257+
## 🚀 Live Demo
258+
259+
**[orbitview-five.vercel.app](https://orbitview-five.vercel.app)**
260+
261+
---
262+
143263
<div align="center">
144-
<sub>Built with ❤️ by the OrbitView Team</sub>
264+
Made with ❤️ for space enthusiasts | v2.2.0 | Last updated: 2026-01-14
145265
</div>

0 commit comments

Comments
 (0)