# ONI Academy

[![PyPI version](https://badge.fury.io/py/oni-academy.svg)](https://badge.fury.io/py/oni-academy)
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)

> **Educational Platform for Neurosecurity** - Learn brain-computer interface security concepts through interactive modules and tutorials.

---

## Overview

ONI Academy is the educational arm of the ONI Framework project. It provides structured learning paths for understanding neural security concepts, from basic principles to advanced attack patterns.

**Why ONI Academy exists:** Neurosecurity concepts are not accessible. While building the ONI Framework, we identified a critical gap — the knowledge needed to secure BCIs is fragmented across academic papers and proprietary training. ONI Academy bridges that gap.

For the full vision and detailed documentation, see [ONI_ACADEMY.md](ONI_ACADEMY.md).

---

## Quick Start

### Installation

```bash
# Basic installation
pip install oni-academy

# Full installation (with interactive UI)
pip install oni-academy[full]
```

### Usage

```python
from oni_academy import list_modules, get_course

# See available learning modules
modules = list_modules()
print(modules)
# ['introduction', '14-layer-model', 'coherence-metric',
#  'neural-firewall', 'attack-patterns', 'nsam-monitoring']

# Get course content
intro = get_course("introduction")
print(intro['title'])
# "Introduction to Open Neurosecurity Interoperability"
```

### CLI

```bash
oni-academy list          # List available modules
oni-academy info intro    # Get module information
oni-academy ui            # Launch interactive UI
```

---

## Package Ecosystem

| Package | Purpose | Install |
|---------|---------|---------|
| **oni-academy** | Educational content, tutorials (this package) | `pip install oni-academy` |
| **oni-framework** | Core API library for BCI security | `pip install oni-framework` |
| **oni-tara** | Security monitoring & attack simulation | `pip install oni-tara` |

**oni-framework is API-only** — use it when building applications. ONI Academy is for learning.

---

## Learning Modules

| Module | Description |
|--------|-------------|
| **Introduction** | Threat landscape, why neurosecurity matters |
| **14-Layer Model** | ONI architecture from silicon to cognition |
| **Coherence Metric** | Signal trust scoring (Cₛ formula) |
| **Neural Firewall** | Zero-trust validation at L8 |
| **Attack Patterns** | Threat modeling for BCIs |
| **NSAM Monitoring** | Real-time security assurance |

---

## Interactive Tools (Web)

No installation required — explore these in your browser:

- [Coherence Metric Playground](https://qikevinl.github.io/ONI/visualizations/01-coherence-metric-playground.html)
- [ONI Layer Explorer](https://qikevinl.github.io/ONI/visualizations/02-oni-layer-explorer.html)
- [NSAM Checkpoint Simulator](https://qikevinl.github.io/ONI/visualizations/04-nsam-checkpoint-simulator.html)
- [Scale-Frequency Navigator](https://qikevinl.github.io/ONI/visualizations/05-scale-frequency-navigator.html)
- [ONI Threat Matrix](https://qikevinl.github.io/ONI/visualizations/06-oni-attack-matrix.html)

---

## Documentation & Resources

**Full documentation on GitHub:**

| Resource | Description |
|----------|-------------|
| [ONI Academy Guide](https://github.com/qikevinl/ONI/blob/main/MAIN/oni-academy/ONI_ACADEMY.md) | Complete installation, learning paths, architecture |
| [ONI Framework Wiki](https://github.com/qikevinl/ONI/blob/main/MAIN/INDEX.md) | Central hub — navigation, dependencies, roadmap |
| [Interactive Demos](https://qikevinl.github.io/ONI/visualizations/) | Browser-based learning tools (no install required) |

**Related packages:**

| Package | Purpose | Install |
|---------|---------|---------|
| [oni-framework](https://pypi.org/project/oni-framework/) | Core API library (for building apps) | `pip install oni-framework` |
| [oni-tara](https://pypi.org/project/oni-tara/) | Security monitoring, attack simulation | `pip install oni-tara` |

---

## License

Apache 2.0

---

*ONI Academy — Lowering the barrier to entry for intellectually curious minds eager to shape the future of neural security.*
