Zyra Documentation

Welcome to the Zyra documentation.

Featured Presentation

Note

Having trouble viewing the embed? Open the slides directly: https://docs.google.com/presentation/d/e/2PACX-1vQkyPFLXOviuJfWFoesFn4UbL08OQ0dg7ydWJlpVghsrrXc9_s4WE1qhGxT4Br1Vx5wVjd-yZCrlzaR/pub?start=false&loop=true&delayms=30000

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
  • VideoTranscoder
  • convert_to_format()
  • convert_to_grib2()
  • extract_metadata()
  • extract_variable()
  • grib_decode()
  • interpolate_time_steps()
  • load_netcdf()
  • normalise_extra_args()
  • pad_missing_frames()
  • run_video_transcode()
  • 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()

Guides

• Discovery Guide
  • Quick Start (CLI)
  • Semantic Search (LLM)
  • Profiles
  • HTTP API
  • Offline Testing
  • API Reference
  • Commands Endpoint and Capabilities
• OpenAPI-Aided Help and Validation
  • Overview
  • CLI (zyra acquire api)
  • API (POST /v1/acquire/api)
  • What is validated
  • Notes
  • Examples
• Stages Overview
  • Import (Acquire)
  • Process
  • Simulate
  • Decide (Optimize)
  • Visualize (Render)
  • Narrate
  • Verify
  • Export (Disseminate)
  • Notes
  • See also
  • Deprecation notes
• Domain APIs (v1)
  • Endpoints
  • Request/Response Shape
  • Auth
  • Examples
  • Notes
  • Error model
• MCP Adapter
  • Overview
  • Discovery
  • JSON-RPC Methods (POST /v1/mcp)
  • Authentication
  • Feature Flags
  • Examples
  • Error Mapping
  • Progress Streaming
  • Quickstart
  • WebSocket Transport
• Narrate Swarm Quickstart
  • Presets and One‑Liners
  • Notes
  • Schema and Programmatic Validation
  • Exit Codes
  • Downloadable JSON Schema

Wiki

• CLI Cheatsheet
  • Import
  • Search
  • Process
  • Visualize
  • Export
  • Piping Patterns
  • Tips
• Dataset Enrichment
  • Levels
  • API (with Search)
  • Transform CLI (batch)
  • Security & Allowed Paths
  • Requirements
  • See Also
• 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
• FAQ & Troubleshooting
  • Installation
  • CLI usage
  • Visualization
  • Environments
  • Where to get help
• 1. Install Zyra
• 2. Explore the CLI
• 3. Your First Workflow
• 4. Next Steps
• Glossary & Terminology
• 🌿 Welcome to Zyra
  • What is Zyra?
  • Why “Zyra”?
  • What You Can Do
  • Start Here
  • Explore More
  • Get Involved
• Install and Extras
  • Python Version
  • Core Install
  • Stage-Focused Extras
  • Focused Extras
  • Examples
  • Notes
• Introduction to Zyra
  • Kid Version
  • High School Version
  • College Version
  • White Paper Version
• 🔍 Logging Overview
• ⚙️ CLI Options
• 📊 Verbosity Levels
• 🖥️ Console Logging
• 📂 File Logging
• 🚨 Error Logging
• ✅ Summary
• Ensuring User Privacy and Security
• Authorized and Licensed Data Usage
• Roadmap & Tracking
• Search API and Profiles
  • CLI
  • HTTP API
  • Enrichment (CLI and API)
  • Enrichment (Overview)
  • Profiles
• Showcase & Use Cases
  • Education
  • Research
  • Operations
  • Media & Outreach
  • Contribute Examples
• Stage Examples
  • 1) import (acquire/ingest)
  • 2) process (transform)
  • 3) simulate (planned)
  • 4) decide (optimize; planned)
  • 5) visualize (render)
  • 6) narrate (planned)
  • 7) verify (planned)
  • 8) export (disseminate/decimate)
• Overview
• Prerequisites
• Getting Started
  • 1. Re-encode a single legacy .mpg to modern H.264
  • 2. Preserve directory structure for a batch conversion
  • 3. Transcode a glob of image sequences
  • 4. SOS legacy preset (recommended .mp4 output)
  • 5. SOS legacy preset with .mpg container (MPEG-2)
• Metadata Workflows
• Advanced Options
• Troubleshooting
• Manual Validation Checklist
• Future Enhancements (tracked in plan)
• 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
• Zyra Workflow Stages
  • Pipeline at a Glance
  • Stages
  • Notes
  • Related Reading
  • Status & Roadmap
• Routers Overview
• Auth Recap
• Common Workflows
• Tags in OpenAPI
• Environment Variables (selected)
• Behind a Proxy (tip)
• API Key Authentication
  • Examples
• Gating /examples in Production
• WebSocket Authentication Behavior
• CORS Configuration
• Reverse Proxy and TLS (Overview)
• MCP and WebSocket Auth
• Throttling Failed Auth Attempts
• Future: Rate Limiting and Observability
• Zyra Assistant Instructions (Deprecated Copy)
• Images at a Glance
• Which Image Should I Use?
• Common Volumes and Environment
• Quick Start
• Build-time Options
• docker-compose Examples
• Troubleshooting
• Key Concepts
• Resolution Flow
• CLI Usage Patterns
  • Acquire over HTTP(S)
  • Acquire over FTP
  • Disseminate via HTTP POST (legacy decimate/post)
  • Disseminate over FTP
• API & MCP Integration
• Testing Tips
• Troubleshooting
• 1. Research & Discovery
• 2. Idea & Proposal
• 3. Branching Model
• 4. Code Development
• 5. Documentation
  • Two Categories:
• 6. Pull Request (PR)
• 7. Review & Merge
• Example End-to-End Flow
• Start Here
• Quick Help
• Patterns & Showcase
• Modules
• API & Deployment
• Policies & Project

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.