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 Data Format
  • 3.1. Latest JSON fields
• 4. Current NRAO/GBO facility adoption status
  • 4.1. Observation modes supported by ODS reporting
  • 4.2. site_id description
  • 4.3. Frequency ranges reported by ODS for NRAO/GBO facilities
• 5. ODS Adoption
  • 5.1. Current ODS Community
    • 5.1.1. Radio Astronomy Observatories
    • 5.1.2. Satellite Operators
  • 5.2. Steps to create one’s own ODS system (for radio observatory user)
• 6. How to interface with the NRAO ODS API
  • 6.1. Authentication
  • 6.2. Getting ODS Data
  • 6.3. Uploading Satellite Avoidance Logs
    • 6.3.1. Upload Instructions
    • 6.3.2. Satellite avoidance log format
    • 6.3.3. File name
    • 6.3.4. Recommendations
  • 6.4. Uploading TLE Data
  • 6.5. Example Python Script
• 7. Relevant Publications
  • 7.1. Product Sheet
  • 7.2. Peer-reviewed Journals
  • 7.3. Conference Presentations
  • 7.4. NRAO RFI Memos
  • 7.5. Summer Student Reports & Presentations
  • 7.6. FCC Rules
  • 7.7. Referenced in FCC Filings
  • 7.8. Coordination Agreements & Announcements
  • 7.9. News Articles
• 8. Relevant Software Tools
• 9. Developer Notes
  • 9.1. Overview
  • 9.2. Core Requirements
  • 9.3. Example Architectures
    • 9.3.1. Example One - Python FastAPI + PostgreSQL
    • 9.3.2. Example Two - Static JSON File
  • 9.4. Best Practices
• 10. Acronym List
• 11. FAQ
  • 11.1. For NRAO/GBO telescope users
  • 11.2. For new ODS users
  • 11.3. General questions
• 12. Changelog
  • 12.1. Online Docs Release Notes
  • 12.2. ODS API Version History
  • 12.3. JSON Schema Change History
• 13. Helpdesk
• 14. Acknowledgements