Home

☢️ Welcome to RadCat

Welcome to the official RadCat documentation.

RadCat is a modular radiation-control and data-processing framework organized into:

• Devices → real hardware controller
• Components → modular drop and go features for people to create devices easily
• Core Systems → communication, trheading, cern root analysis, graphing etc.

🚀 Getting Started

📘 General Overview

A high-level explanation of what RadCat is and how the system is built.
➡️ General

🛠 Requirements to Develop

Before contributing or compiling RadCat, make sure you have the correct toolchain and dependencies.
➡️ Requirements to Develop

⚙️ Devices

🔧 Device Core

Architecture overview, update flow, event communication, lifecycle, I/O, and internal behavior.
➡️ Device Core

📑 Device Registry

How devices are registered, discovered, and instantiated.
➡️ Device Registry

📦 Base Device

The parent class all devices derive from.
➡️ Base Device

🧩 Components

Components give devices extra capabilities. Like drawing graphs, connecting in a specific way like FTDI chips, handling signals from other devices etc.

🧠 Component Core System

➡️ Component Core System

📚 Additional Resources

These sections will be expanded in the future:

• API Reference
• Examples & Tutorials
• Developer Notes
• Roadmap & Plans

🤝 Contributing

RadCat is open source and community driven framework. If you are interested in contributing you can do so with the ways below.

• Check open issues
• Submit clean and documented PRs

If you are planning to develop RadCat, don't forget to read development rules.
➡️ Development Rules

⭐ Support RadCat

If you find RadCat useful, consider giving the repository a ⭐ on GitHub — it helps visibility and encourages development.