ODS API Server Documentation

Contents:

• 1. Operational Data Sharing (ODS) v1.0.0
  • 1.1. How ODS Works
  • 1.2. How TBA Works
• 2. ODS Use Cases
  • 2.1. Assumptions
    • 2.1.1. Target position and pointing
    • 2.1.2. Atmospheric refraction
  • 2.2. Sidereal targets
  • 2.3. Non-sidereal sources
    • 2.3.1. Slow-moving non-sidereal targets
    • 2.3.2. Fast-moving non-sidereal targets
    • 2.3.3. On-Off source observing strategy
    • 2.3.4. Telescope Stowing
  • 2.4. Single dish and arrays
  • 2.5. Possible future ODS use cases
• 3. ODS Adoption
  • 3.1. Current NRAO/GBO facility adoption status
    • 3.1.1. site_id description
    • 3.1.2. Frequency ranges reported by ODS for NRAO/GBO facilities
    • 3.1.3. Observation modes supported by ODS reporting
  • 3.2. Current ODS Community
    • 3.2.1. Radio Astronomy Observatories
    • 3.2.2. Satellite Operators
  • 3.3. Steps to create one’s own ODS system (for radio observatory user)
  • 3.4. Relevant software tools
• 4. ODS Data Format
  • 4.1. Latest JSON fields
• 5. How to interface with the NRAO ODS API
  • 5.1. Authentication
  • 5.2. Getting ODS Data
  • 5.3. Uploading Satellite Avoidance Logs
    • 5.3.1. Upload Instructions
    • 5.3.2. Satellite avoidance log format
    • 5.3.3. File name
    • 5.3.4. Recommendations
  • 5.4. Uploading TLE Data
  • 5.5. Example Python Script
• 6. Relevant Publications
  • 6.1. Product Sheet
  • 6.2. Peer-reviewed Journals
  • 6.3. Conference Presentations
  • 6.4. NRAO RFI Memos
  • 6.5. Summer Student Reports & Presentations
  • 6.6. FCC Rules
  • 6.7. Referenced in FCC Filings
  • 6.8. Coordination Agreements & Announcements
  • 6.9. News Articles
• 7. Developer Notes
  • 7.1. Overview
  • 7.2. Core Requirements
  • 7.3. Example Architectures
    • 7.3.1. Example One - Python FastAPI + PostgreSQL
    • 7.3.2. Example Two - Static JSON File
  • 7.4. Best Practices
• 8. Acronym List
• 9. FAQ
• 10. Changelog
  • 10.1. Online Docs Release Notes
  • 10.2. ODS API Version History
  • 10.3. JSON Schema Change History
• 11. Helpdesk
• 12. Acknowledgements