# 🌿 Welcome to Zyra

[![Zyra Presentation](https://github.com/user-attachments/assets/24b250cd-f4f1-4f47-a378-abba43af253d)](https://docs.google.com/presentation/d/1hdB2qLgzdiHQUzB3u_Mv2gU1wdh8xbcWsOh-dXjz9ME/present?usp=sharing)

---

## What is Zyra?

**Zyra** (pronounced *Zy-rah*) is an open-source Python framework for **growing data into insight**.  

It helps scientists, educators, and developers build **modular, reproducible workflows** that transform raw data into clear visualizations and shareable knowledge.  

Think of Zyra as a **garden for data**:  
- You **plant seeds** of data (from the web, satellites, or experiments).  
- Zyra helps you **nurture and grow them** (through filtering, analysis, and processing).  
- Finally, you **harvest insights** (in the form of visualizations, reports, and interactive media).  

It’s designed to make science not just rigorous, but also **accessible, transparent, and beautiful**.

---

## Why “Zyra”?

Zyra evokes growth and flow — small seeds of data can flourish into full workflows, and threads of analysis can be woven into something reproducible and sharable. It’s intentionally short and flexible so the community can shape its meaning over time.

---

## What You Can Do

- **Build pipelines** that fetch, process, visualize, and publish data.
- **Reuse components** (connectors, processors, plotters) across projects.
- **Keep work reproducible** with configs, logs, and structured outputs.

---

## Start Here

- Overview: [Introduction](Introduction)
- Stages: [Workflow Stages](Workflow-Stages)
- Quickstart: [Getting Started](Getting-Started-with-Zyra)
- Install & Extras: [Install & Extras](Install-Extras)
- Patterns: [Pipeline Patterns](Pipeline-Patterns)
- Stage Examples: [Stage Examples](Stage-Examples)
- Stage Agents: [Zyra Swarm](Stage-Agents-and-Planner-Overview)
- CLI Reference: https://noaa-gsl.github.io/zyra/api/zyra.cli.html

---

## Explore More

### Assistant & Guidance
- [![Chat with Zyra Assistant](https://img.shields.io/badge/ChatGPT-Zyra%20Assistant-00A67E?logo=openai&logoColor=white)](https://assistant.zyra-project.org/)
- Zyra Assistant Instructions: [Zyra-Assistant-Instructions](Zyra-Assistant-Instructions)
- Wizard Assistant: [Wizard-Interactive-Assistant](Wizard-Interactive-Assistant)

### Module Docs
- Connectors: https://noaa-gsl.github.io/zyra/api/zyra.connectors.html
- Processing: https://noaa-gsl.github.io/zyra/api/zyra.processing.html
- Visualization: https://noaa-gsl.github.io/zyra/api/zyra.visualization.html
- Transform: https://noaa-gsl.github.io/zyra/api/zyra.transform.html
- Utils: https://noaa-gsl.github.io/zyra/api/zyra.utils.html

### API & Deployment
- API Routers & Endpoints: [Zyra-API-Routers-and-Endpoints](Zyra-API-Routers-and-Endpoints)
- API (module docs): https://noaa-gsl.github.io/zyra/api/zyra.api.html
- Security Quickstart: [Zyra-API-Security-Quickstart](Zyra-API-Security-Quickstart)
- Containers Overview: [Zyra-Containers-Overview-and-Usage](Zyra-Containers-Overview-and-Usage)

### Policies & Discovery
- Privacy & Data Usage: [Privacy-and-Data-Usage-Best-Practices-for-Zyra](Privacy-and-Data-Usage-Best-Practices-for-Zyra)
- Search API & Profiles: [Search-API-and-Profiles](Search-API-and-Profiles)
- Glossary & Terminology: [Glossary-and-Terminology](Glossary-and-Terminology)

### Ideas & Showcase
- Insights from Similar Tools: [Enhancing-Zyra-Through-Insights-from-Similar-Tools](Enhancing-Zyra-Through-Insights-from-Similar-Tools)
- Showcase & Use Cases: [Showcase-and-Use-Cases](Showcase-and-Use-Cases)

### Quick Help
- CLI Cheatsheet: [CLI-Cheatsheet](CLI-Cheatsheet)
- FAQ & Troubleshooting: [FAQ-and-Troubleshooting](FAQ-and-Troubleshooting)
- Dataset Enrichment: [Dataset-Enrichment](Dataset-Enrichment)

---

## Get Involved

- Repository: https://github.com/NOAA-GSL/zyra
- Discussions: https://github.com/NOAA-GSL/zyra/discussions
- Contributing: https://github.com/NOAA-GSL/zyra/blob/main/CONTRIBUTING.md

---

✨ Zyra is where data grows into insight.