Zyra

API Reference

  • Zyra API
    • zyra package
      • Subpackages
      • Module contents

Packages

  • zyra.visualization package
    • AnimateManager
      • AnimateManager.configure()
      • AnimateManager.render()
      • AnimateManager.save()
    • ColormapManager
      • ColormapManager.configure()
      • ColormapManager.create_custom_classified_cmap()
      • ColormapManager.create_custom_cmap()
      • ColormapManager.render()
      • ColormapManager.save()
    • ContourManager
      • ContourManager.configure()
      • ContourManager.render()
      • ContourManager.save()
    • HeatmapManager
      • HeatmapManager.configure()
      • HeatmapManager.render()
      • HeatmapManager.save()
    • InteractiveManager
      • InteractiveManager.configure()
      • InteractiveManager.render()
      • InteractiveManager.save()
    • PlotManager
      • PlotManager.configure()
      • PlotManager.plot_data_array()
      • PlotManager.render()
      • PlotManager.save()
      • PlotManager.sos_plot_data()
    • Renderer
      • Renderer.configure()
      • Renderer.render()
      • Renderer.save()
    • TimeSeriesManager
      • TimeSeriesManager.configure()
      • TimeSeriesManager.render()
      • TimeSeriesManager.save()
    • VectorFieldManager
      • VectorFieldManager.configure()
      • VectorFieldManager.render()
      • VectorFieldManager.save()
    • VectorParticlesManager
      • VectorParticlesManager.configure()
      • VectorParticlesManager.render()
      • VectorParticlesManager.save()
    • add_basemap_cartopy()
    • add_basemap_tile()
    • apply_matplotlib_style()
    • Core modules
      • Renderer
      • PlotManager
      • ColormapManager
      • add_basemap_cartopy()
      • add_basemap_tile()
    • Managers
      • HeatmapManager
      • ContourManager
      • VectorFieldManager
      • ParticleFrame
      • VectorParticlesManager
      • TimeSeriesManager
      • AnimateManager
      • FrameInfo
      • InteractiveManager
    • Styles and CLI
      • apply_matplotlib_style()
      • timestamp_anchor()
      • main()
      • features_from_ns()
      • resolve_basemap_ref()
      • handle_animate()
      • handle_compose_video()
      • handle_contour()
      • handle_heatmap()
      • handle_interactive()
      • handle_timeseries()
      • handle_vector()
  • zyra.processing package
    • DataProcessor
      • DataProcessor.features
      • DataProcessor.load()
      • DataProcessor.process()
      • DataProcessor.save()
      • DataProcessor.validate()
    • DecodedGRIB
      • DecodedGRIB.backend
      • DecodedGRIB.dataset
      • DecodedGRIB.messages
      • DecodedGRIB.path
      • DecodedGRIB.meta
      • DecodedGRIB.backend
      • DecodedGRIB.dataset
      • DecodedGRIB.messages
      • DecodedGRIB.meta
      • DecodedGRIB.path
    • GRIBDataProcessor
      • GRIBDataProcessor.FEATURES
      • GRIBDataProcessor.combine_into_3d_array()
      • GRIBDataProcessor.list_datasets()
      • GRIBDataProcessor.load()
      • GRIBDataProcessor.load_data_from_file()
      • GRIBDataProcessor.process()
      • GRIBDataProcessor.process_grib_files_wgrib2()
      • GRIBDataProcessor.read_grib_file()
      • GRIBDataProcessor.read_grib_to_numpy()
      • GRIBDataProcessor.save()
      • GRIBDataProcessor.shift_data_180()
    • VariableNotFoundError
    • VideoProcessor
      • VideoProcessor.FEATURES
      • VideoProcessor.check_ffmpeg_installed()
      • VideoProcessor.load()
      • VideoProcessor.process()
      • VideoProcessor.process_video()
      • VideoProcessor.save()
      • VideoProcessor.validate()
      • VideoProcessor.validate_frame_count()
      • VideoProcessor.validate_video_file()
    • VideoTranscoder
      • VideoTranscoder.DEFAULT_AUDIO_CODECS
      • VideoTranscoder.DEFAULT_CODECS
      • VideoTranscoder.DEFAULT_CONTAINER_EXT
      • VideoTranscoder.from_namespace()
      • VideoTranscoder.run()
    • 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
      • DataProcessor
      • FrameRecord
      • FramesCatalog
      • IndicatorSpec
      • pad_missing_frames()
      • parse_indicator()
      • VideoProcessor
      • TranscodeResult
      • TranscodeTask
      • VideoTranscodeConfig
      • VideoTranscodeError
      • VideoTranscoder
      • normalise_extra_args()
      • run_video_transcode()
      • GRIBDataProcessor
      • interpolate_time_steps()
      • DecodedGRIB
      • VariableNotFoundError
      • convert_to_format()
      • extract_metadata()
      • extract_variable()
      • grib_decode()
      • validate_subset()
      • convert_to_grib2()
      • load_netcdf()
      • subset_netcdf()
  • zyra.connectors package
    • Subpackages
      • zyra.connectors.discovery package
    • Module contents
      • ByteRanged
      • Connector
      • Deletable
      • Existsable
      • FTPConnector
      • Fetchable
      • Indexable
      • Listable
      • S3Connector
      • Statable
      • Uploadable
  • zyra.utils package
    • CredentialManager
      • CredentialManager.add_credential()
      • CredentialManager.clear_credentials()
      • CredentialManager.delete_credential()
      • CredentialManager.get_credential()
      • CredentialManager.list_credentials()
      • CredentialManager.read_credentials()
      • CredentialManager.tracked_keys
    • DateManager
      • DateManager.__init__()
      • DateManager.calculate_expected_frames()
      • DateManager.datetime_format_to_regex()
      • DateManager.extract_date_time()
      • DateManager.extract_dates_from_filenames()
      • DateManager.find_missing_frames()
      • DateManager.find_missing_frames_and_predict_names()
      • DateManager.find_start_end_datetimes()
      • DateManager.get_date_range()
      • DateManager.get_date_range_iso()
      • DateManager.is_date_in_range()
      • DateManager.parse_timestamps_from_filenames()
    • FileUtils
    • JSONFileManager
      • JSONFileManager.read_file()
      • JSONFileManager.read_json()
      • JSONFileManager.save_file()
      • JSONFileManager.update_dataset_times()
      • JSONFileManager.write_json()
    • remove_all_files_in_directory()
    • Modules
      • CredentialManager
      • DateManager
      • FileUtils
      • remove_all_files_in_directory()
      • JSONFileManager
      • configure_logging_from_env()
      • detect_format_bytes()
      • is_grib2_bytes()
      • is_netcdf_bytes()
      • parse_levels_arg()
      • read_all_bytes()
      • sanitize_args()
      • sanitize_for_log()
      • temp_file_from_bytes()
      • open_input()
      • open_input_file()
      • open_output()
      • open_output_file()
      • detect_crs_from_csv()
      • detect_crs_from_path()
      • detect_crs_from_xarray()
      • to_cartopy_crs()
      • warn_if_mismatch()
      • compute_chunks()
      • ensure_idx_path()
      • idx_to_byteranges()
      • parallel_download_byteranges()
      • parse_idx_lines()
  • zyra.api package
    • Submodules
      • zyra.api.server module
      • zyra.api.routers.cli module
      • zyra.api.routers.search module
  • 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
      • Example OpenAPI snippet
      • CLI
      • HTTP
  • 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
      • Prerequisites
      • Discover tools (HTTP)
      • JSON-RPC examples
    • WebSocket Transport
      • IDE integration notes
      • See also
  • 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
      • Assistant & Guidance
      • Module Docs
      • API & Deployment
      • Policies & Discovery
      • Ideas & Showcase
      • Quick Help
    • 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
      • Motivation & Scope
      • Design Principles
      • Architecture (stages β†’ modules)
      • Execution Model
      • Data & Formats
      • Configuration & Metadata
      • Extensibility
      • Security & Compliance
      • Performance Considerations
      • Deployment Modes
      • Limitations & Roadmap
      • References
  • πŸ” 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
      • Analysis (LLM ranking)
    • 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
      • 1. Import (aliases: acquire, ingest)
      • 2. Process (alias: transform)
      • 3. Simulate
      • 4. Decide (alias: optimize)
      • 5. Visualize (alias: render)
      • 6. Narrate
      • 7. Verify
      • 8. Export (alias: disseminate; legacy: decimate)
    • 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
    • Why
    • How
    • Editing Rules
Zyra
  • zyra.api package
  • View page source

zyra.api package

Submodules

  • zyra.api.server module
  • zyra.api.routers.cli module
  • zyra.api.routers.search module
Previous Next

© Copyright 2025, NOAA-GSL.

Built with Sphinx using a theme provided by Read the Docs.