Zyra Documentation

Welcome to the Zyra documentation.

Contents

API Reference

• Zyra API
  • zyra package

Packages

• zyra.visualization package
  • AnimateManager
  • ColormapManager
  • ContourManager
  • HeatmapManager
  • InteractiveManager
  • PlotManager
  • Renderer
  • TimeSeriesManager
  • VectorFieldManager
  • VectorParticlesManager
  • add_basemap_cartopy()
  • add_basemap_tile()
  • apply_matplotlib_style()
  • Core modules
  • Managers
  • Styles and CLI
• zyra.processing package
  • DataProcessor
  • DecodedGRIB
  • GRIBDataProcessor
  • VariableNotFoundError
  • VideoProcessor
  • convert_to_format()
  • convert_to_grib2()
  • extract_metadata()
  • extract_variable()
  • grib_decode()
  • interpolate_time_steps()
  • load_netcdf()
  • subset_netcdf()
  • validate_subset()
  • Modules
• zyra.connectors package
  • Subpackages
  • Module contents
• zyra.utils package
  • CredentialManager
  • DateManager
  • FileUtils
  • JSONFileManager
  • remove_all_files_in_directory()
  • Modules
• zyra.api package
  • Submodules
• zyra.assets package
  • Subpackages
• zyra.cli module
  • cmd_convert_format()
  • cmd_decode_grib2()
  • cmd_extract_variable()
  • main()
• zyra.transform module
  • register_cli()

Wiki

• Goals
• 1. Add Branch-Aware GitHub Action for Wiki Sync
• 2. Update Sphinx to Support Wiki Pages
• 3. Add Wiki to Docs Site Navigation
• 4. Add Contributor Documentation
• 5. Remove Docker-Based Wiki Sync
• 6. Verify End-to-End
• Deliverables
• Benefits
• Enhancing Zyra Through Insights from Similar Tools
  • Overview of Zyra and Its Goals
  • Open-Source Visualization Tools and Libraries
  • UI-Driven Commercial Platforms and Their Features
  • Extending Beyond 2:1 Equirectangular Globes
  • Making Zyra More User-Friendly
  • Conclusion
• 1. Install Zyra
• 2. Explore the CLI
• 3. Your First Workflow
• 4. Next Steps
• Source Usage Guidelines
• GitHub Action Usage
• CLI Manifest Action Usage
• Usage Best Practices
• Interpretation Rules
• Response Structure
• Cross-Linking Behavior
• Scope and Boundaries
• Code Quality & Safety Checks
• Escalation and Community Guidance
• 🌿 Welcome to Zyra
  • What is Zyra?
  • Why “Zyra”?
  • A Framework for Everyone
  • Quickstart
  • Introduction
  • 📖 Explore More
  • Get Involved
• 1. Repository & GitHub Setup
• 2. Codebase Changes
  • 2.1 Core Package
  • 2.2 Compatibility Shim
  • 2.3 Configuration
• 3. Documentation Updates
• 4. Tests
• 5. Packaging & Distribution
• 6. Community & Communication
• 7. Migration Timeline
• 8. Verification
• Deliverables
• Phase 1: Module Scaffolding
• Phase 2: Backends for Discovery
• Phase 3: Integration with CLI
• Phase 4: API Integration
• Phase 5: Connectors Integration
• Phase 6: Documentation & Examples
• Stretch Goals
• 1. Use Case & Goals
• 2. Placement in Pipeline
• 3. Technical Approach
  • a. GRIB2 input
  • b. NetCDF/Zarr input
  • c. Output
• 4. CLI Design
• 5. Integration with IDX (Future)
• 6. Implementation Steps
• 7. Milestones
• 1. Use Case & Goals
• 2. Placement in Pipeline
• 3. Technical Approach
  • a. LLM Provider Abstraction
  • b. Workflow Translation
  • c. Session State
  • d. Safety & Guardrails
• 4. CLI Design
• 5. Implementation Steps
• 6. Milestones
• Introduction to Zyra
  • Kid Version
  • High School Version
  • College Version
  • White Paper Version
• Ensuring User Privacy and Security
• Authorized and Licensed Data Usage
• References
• CLI
  • Semantic Search (LLM-assisted)
  • Semantic Analysis (LLM ranking)
• HTTP API
  • Offline testing with local files
• Profiles
• 1. FTP (acquisition/ftp_manager.py)
  • Current (legacy)
  • Migration
• 2. HTTP (acquisition/http_manager.py)
  • Current (legacy)
  • Migration
• 3. S3 (acquisition/s3_manager.py)
  • Current (legacy)
  • Migration
• 4. Vimeo (acquisition/vimeo_manager.py)
  • Current (legacy)
  • Migration
• 5. GRIB Utils (acquisition/grib_utils.py)
  • Current (legacy)
  • Migration
• 6. Pipeline & CLI Enhancements
• 7. Removal of acquisition/
• Outcome
• Overview
• Quick Start
• Options
• Providers & Environment
• Configuration & Precedence
• How It Works
• Session Memory (Interactive)
• Command History
• Usage Examples
  • Sample JSONL Log
• Logging
• Capabilities Manifest
• Manifest Schema (Draft)
  • Example: Before → After
  • How Wizard Uses path_arg
  • Incremental Adoption
  • Groups and Defaults
• Limitations (MVP)
• Roadmap
• Troubleshooting
• Routers Overview
• Auth Recap
• Common Workflows
• Tags in OpenAPI
• Environment Variables (selected)
• API Key Authentication
  • Examples
• Gating /examples in Production
• WebSocket Authentication Behavior
• CORS Configuration
• Reverse Proxy and TLS (Overview)
• Future: Rate Limiting and Observability
• Goal
• 1. Refactor CLI Structure
  • 1.1 Top-Level Groups
  • 1.2 Module Self-Registration
• 2. Connectors Module Structure
  • 2.1 Ingest
  • 2.2 Egress
• 3. Processing (src/zyra/processing/)
• 4. Visualization (src/zyra/visualization/)
• 5. Shared Features
  • 5.1 I/O Utilities
  • 5.2 Format Detection
  • 5.3 Common CLI Options
• 6. Pipeline Configs
  • 6.1 CLI Usage
  • 6.2 YAML Example
  • 6.3 Implementation
• 7. Streaming Support
• 8. Testing
• 9. Documentation
• Goal
• 1. Project Structure
• 2. FastAPI Endpoints
  • 2.1 Run CLI Command (Sync or Async)
  • 2.2 Upload Data
  • 2.3 Download Results
  • 2.4 WebSocket Progress
  • 2.5 Job Management
• 3. Internal Execution Model
  • 3.1 Command Registry
  • 3.2 Synchronous Execution with Logging & Exit Code
  • 3.3 Asynchronous Execution
• 4. Bonus Features Implementation
  • 4.1 File Upload Handling
  • 4.2 Result Download
  • 4.3 WebSocket Streaming
• 5. Security
• 6. Deployment
  • 6.1 Local Dev
  • 6.2 Production
• 7. Dev Container Auto-Startup
  • 7.1 Startup Script
  • 7.2 Devcontainer Hook
  • 7.3 Background Mode (optional)
• 8. Testing
• 9. Documentation
• 1. Setup & Structure
• 2. Basemap Enhancements
• 3. Visualization Types
• 4. CLI Preparation (Module-Only)
• 5. API Preparation (Stub Functions)
• 6. Styles
• 7. Testing
• 8. Dependencies
• 1. Goal
• 2. Node Package Structure
• 3. Credentials
• 4. Node Types
  • 4.1 Acquire Node
  • 4.2 Process Node
  • 4.3 Visualize Node
  • 4.4 Decimate Node
• 5. Execution Logic with Logs & Exit Code
• 6. Dynamic Command Loading
• 7. Debugging in n8n
• 8. Bonus Features
• 9. Advantages of One Node Per Module
• 10. Future Extension
  • Visualization Node

Contributing

• Wiki Sync Workflow

External Wiki

For human-authored guidance, design notes, and usage guides, see the project wiki:

• Online: https://github.com/NOAA-GSL/zyra/wiki

• Synced copy is included in this documentation under the “Wiki” section.