README.md

ContrAI 🛰️

A Python library for contrail detection and analysis using AI models.

---

🧠 Features

• Automated contrail detection using deep learning
• Image preprocessing and overlay visualization
• Easy-to-use Python API

---

🚀 Installation

Create a conda environment:

conda create -n contrai_env python=3.10
conda activate contrai_env

Install the latest released version from PyPI:

pip install -U contrai

---

🧠 Jupyter Notebook Examples

Explore how to use this package with ready-to-run notebooks:

• 📕 GOES-16 Data Download Example
  Explores accessing and downloading GOES-16 ABI satellite imagery.

• 📘 Contrail Detection Example
  Demonstrates how to run a contrail detection model on a .png ash RGB image file.

• 📗 Polygon Dataset Visualization
  Shows how to visualize and inspect the polygon-based contrail dataset.

---

🌍 Interactive Contrail Detection Demo

Click the button below to view the fully interactive contrail detection output visualization:

---

📚 Citation

If you use this package in your research, please cite:

---

⚖️ License

This project is licensed under the Apache 2.0 License.

---

👥 Community

We welcome feedback, discussions, and contributions!
If you have suggestions, find a bug, or want to collaborate, feel free to open an issue or start a discussion.

---

Note: This is the first release and will be updated soon with additional features for satellite contrail analysis and improvements to current capabilities.

---

_{2025 ContrAI.}