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()
      • 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()
    • convert_to_format()
    • convert_to_grib2()
    • extract_metadata()
    • extract_variable()
    • grib_decode()
    • interpolate_time_steps()
    • load_netcdf()
    • subset_netcdf()
    • validate_subset()
    • Modules
      • DataProcessor
      • VideoProcessor
      • 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
    • 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.save_file()
      • JSONFileManager.update_dataset_times()
    • 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()
      • temp_file_from_bytes()
      • open_input()
      • open_output()
      • 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.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
      • Kid Version
      • High School Version
      • College Version
      • White Paper Version
    • πŸ“– 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
    • Why
    • How
    • Editing Rules
Zyra
  • Zyra API
  • View page source

Zyra API

  • zyra package
    • Subpackages
    • Module contents
Previous Next

© Copyright 2025, NOAA-GSL.

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