Skip to content

Commit b1384f0

Browse files
committed
Update docs
1 parent 33df5e9 commit b1384f0

File tree

8 files changed

+232
-82
lines changed

8 files changed

+232
-82
lines changed

docs/antares-cli.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,20 @@
11
---
2-
title: "🛠️ antares-cli: Command-Line Control"
3-
description: "Use the antares-cli tool to prototype, command, and collect data from Antares simulations."
2+
order: 4
3+
icon: fas fa-terminal
4+
title: antares-cli
5+
description: >-
6+
A command-line interface for prototyping, commanding, and collecting data from Antares simulations.
47
---
58

69
## 🛠️ antares-cli: Command-Line Control
710

811
> **A lightweight interface for controlling Antares simulations via terminal commands.**
12+
{: .prompt-tip }
913

1014
`antares-cli` is a powerful tool for prototyping behaviors, capturing telemetry logs, and issuing real-time commands to the Antares simulation system — useful in both development and operational research settings.
1115

12-
---
16+
![CLI Usage](https://raw.githubusercontent.com/TheSoftwareDesignLab/ANTARES/refs/heads/main/docs/assets/antares-cli.png){: width="700" }
17+
_Subscribing to simulation events and issuing commands via the CLI._
1318

1419
## ⚙️ Core Capabilities
1520

@@ -22,8 +27,6 @@ description: "Use the antares-cli tool to prototype, command, and collect data f
2227

2328
➡️ Multiple CLI clients can connect concurrently to a central simulation — ideal for distributed experimentation.
2429

25-
---
26-
2730
## 🚧 Usage
2831

2932
Once installed, the `antares-cli` binary is available globally.
@@ -45,13 +48,11 @@ Once installed, the `antares-cli` binary is available globally.
4548
| `--verbose` | Enable detailed output |
4649
| `--json` | Output results in JSON format (structured logs) |
4750

48-
---
49-
5051
## 💡 Example
5152

5253
```bash
5354
antares-cli add-ship --type line --x 0 --y 0 --angle 0.5 --speed 5.0
54-
````
55+
```
5556

5657
➡️ This creates a ship moving along a fixed heading at 5 m/s.
5758
You can then subscribe to track updates and log them using:
@@ -60,8 +61,6 @@ You can then subscribe to track updates and log them using:
6061
antares-cli subscribe
6162
```
6263

63-
---
64-
6564
## 📎 Technical Details
6665

6766
For installation instructions, configuration schema, and developer options, see the [antares-python GitHub repository](https://github.com/jsurrea/antares-python).

docs/antares-python.md

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
order: 3
3-
icon: fas fa-terminal
4-
title: antares-cli
3+
icon: fas fa-robot
4+
title: Antares Python Client
55
description: >-
6-
A command-line interface for prototyping, commanding, and collecting data from Antares simulations.
6+
A high-level Python library for integrating Antares simulations into real-time AI, control, and monitoring systems.
77
---
88

99
## 🧠 What is the Antares Python Client?
@@ -12,8 +12,6 @@ The **Antares Python Client** is a high-level, developer-friendly library that a
1212

1313
Whether you're prototyping autonomous decision-making systems, testing radar algorithms, or integrating simulations into command dashboards, `antares-python` makes it possible - and remarkably simple.
1414

15-
---
16-
1715
## ⚙️ Why Python?
1816

1917
Python is the language of choice for:
@@ -25,8 +23,6 @@ Python is the language of choice for:
2523

2624
With `antares-python`, you can embed Rust-powered realistic, high-frequency maritime simulations directly into those environments — enabling closed-loop testing, ML training, or control logic validation at scale.
2725

28-
---
29-
3026
## 📦 Python Integration in 30 Seconds
3127

3228
```python
@@ -49,8 +45,6 @@ async for track in client.subscribe():
4945

5046
➡️ *Spawn a ship and react to its telemetry in real time. Combine with tactical logic or AI systems for autonomous decisions.*
5147

52-
---
53-
5448
## 🛰️ Use Cases in Autonomous & Military Systems
5549

5650
Antares Python Client acts as a **simulation substrate** for intelligent systems. Key applications include:
@@ -70,8 +64,6 @@ Antares Python Client acts as a **simulation substrate** for intelligent systems
7064
***System validation under uncertainty**
7165
Test robustness of autonomous systems against unpredictable scenarios, sensor degradation, or adversarial tactics.
7266

73-
---
74-
7567
## 🌍 Designed for Integration
7668

7769
You can easily:
@@ -83,14 +75,10 @@ You can easily:
8375

8476
Antares Python Client has **zero external dependencies** beyond its own models and tools, ensuring it's lightweight and portable — ideal for secure or isolated environments.
8577

86-
---
87-
8878
## 🛡️ Robust. Modular. Battle-Ready.
8979

9080
Whether you're building mission rehearsal tools, tactical planning apps, or AI-controlled defense simulations — `antares-python` offers a powerful, production-ready foundation for integration, testing, and innovation.
9181

92-
---
93-
9482
## 🔗 Learn More
9583

9684
Full technical details, API reference, and source code are available at the [GitHub repository](https://github.com/TheSoftwareDesignLab/ANTARES/antares-python).

docs/antares-simulator.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
order: 1
3+
icon: fas fa-satellite-dish
4+
title: Antares Simulator
5+
mermaid: true
6+
description: >-
7+
A high-fidelity simulation engine for maritime radar and sensor systems, designed for real-time experimentation and analysis.
8+
---
9+
10+
# 🧠 ANTARES Simulator
11+
12+
> The core of the platform: a high-fidelity, real-time radar simulation engine built for performance, extensibility, and operational realism.
13+
{: .prompt-info }
14+
15+
## 🎯 Purpose
16+
17+
The simulator models **naval radar operations** in dynamic maritime scenarios, supporting both training and system integration efforts.
18+
It enables reproducible experiments, behavior analysis, and real-time radar tracking.
19+
20+
## 🔄 Architecture Overview
21+
22+
- **Built in Rust**: Ensures high performance, type safety, and memory security.
23+
- **Command-Driven**: Controlled via TCP messages for full integration flexibility.
24+
- **Event Loop Core**: Uses a time-stepped loop to simulate real-world radar behavior.
25+
- **Data Broadcast**: Publishes `Track` objects in real-time to subscribers (via TCP or WebSocket).
26+
27+
```mermaid
28+
flowchart TD
29+
A[Simulation Controller] --> B[World State Engine]
30+
B --> C[Ship Dynamics]
31+
B --> D[Radar Signal Generator]
32+
D --> E[Track Data Stream]
33+
```
34+
35+
> Track data can be consumed by GUI clients, automated systems, or external C4I modules.
36+
> {: .prompt-tip }
37+
38+
## 📦 Use Cases
39+
40+
* 🧭 **Officer Training Simulations**
41+
Build realistic operational scenarios without physical deployments.
42+
43+
* 🔍 **Sensor Behavior Testing**
44+
Validate how detection algorithms react under different vessel configurations.
45+
46+
* 🧪 **System Integration & Interoperability**
47+
Emulate radar behavior to test communication with external systems (e.g., CMS, C4I).
48+
49+
* 🧰 **Research and Development**
50+
Rapidly prototype and validate new tracking algorithms or radar control strategies.
51+
52+
## 🛠️ Configuration
53+
54+
Simulation parameters are defined via structured TOML or TCP commands.
55+
Entities are configurable with:
56+
57+
* Initial position, heading, and velocity
58+
* Radar range, scan rate, and update interval
59+
* Behavioral strategies and decision logic
60+
61+
> Ships and radars can be added, modified, or removed at runtime.
62+
> {: .prompt-info }
63+
64+
## Learn More
65+
66+
For source code, contributions, or in-depth technical details, visit the GitHub repository:
67+
👉 [https://github.com/TheSoftwareDesignLab/ANTARES/antares](https://github.com/TheSoftwareDesignLab/ANTARES/antares)
68+

docs/antares-web.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
order: 2
3+
icon: fas fa-pager
4+
title: Antares Web Radar
5+
description: >-
6+
A real-time web-based radar visualization and experimentation tool built for rapid prototyping and analysis.
7+
---
8+
9+
## Overview
10+
11+
**Antares Web Radar** is an interactive, browser-based radar interface designed to **visualize, analyze, and command radar simulations** in real time. Built for defense research, operational testing, and prototyping scenarios, it provides a seamless way to **observe radar data** with minimal setup or installation.
12+
13+
By abstracting complexity and exposing only the necessary controls and data streams, Antares Web Radar empowers engineers, analysts, and decision-makers to **focus on the tactical implications of sensor data**, not the plumbing behind it.
14+
15+
## Key Features
16+
17+
### 🔍 Live Visualization of Radar Tracks
18+
- Real-time display of **moving targets** and **navigational aids** (ATONs) over a configurable radar canvas.
19+
- Automatic detection and **consolidation of multiple echoes** for the same object.
20+
- Intuitive visualization of **range, speed, and bearing** for all tracked entities.
21+
22+
### 🧪 Rapid Experimentation
23+
- Seamlessly issue **commands to the simulation engine** such as adding vessels or resetting scenarios.
24+
- Built-in interface for configuring ships with different radar signatures, kinematics, and identifiers.
25+
- Designed to support **live experiments and training exercises** with minimal latency.
26+
27+
### 🛰️ WebSocket Integration
28+
- Connects to a live radar stream via WebSocket for **low-latency data ingestion**.
29+
- Decodes structured telemetry modeled after standard radar output formats (e.g. range, bearing, position, velocity).
30+
31+
### ⚙️ Zero-Install, Full Capability
32+
- Entirely web-based: just open the browser and connect.
33+
- Configurable via `.env` settings for controller and radar endpoints.
34+
- No installation or compilation required—**works out of the box** in any modern web browser.
35+
36+
## Use Cases
37+
38+
- **Sensor behavior validation**: visualize how changes in radar settings or environment affect target tracking.
39+
- **Command & control prototyping**: simulate real-world scenarios and test control interfaces.
40+
- **Training support**: provide operators or researchers with an intuitive radar feed for interpretation practice.
41+
- **Tactical replay and debrief**: re-run scenarios and observe how the system behaved under various configurations.
42+
43+
## Screenshots
44+
45+
![Antares Radar UI](https://raw.githubusercontent.com/TheSoftwareDesignLab/ANTARES/refs/heads/main/docs/assets/antares-radar-ui.png){: width="700" }
46+
_Live radar display with multiple dynamic targets_
47+
48+
![Ship Configuration Modal](https://raw.githubusercontent.com/TheSoftwareDesignLab/ANTARES/refs/heads/main/docs/assets/antares-ship-config.png){: width="700" }
49+
_Adding a new vessel with customizable parameters_
50+
51+
## Learn More
52+
53+
For source code, contributions, or in-depth technical details, visit the GitHub repository:
54+
👉 [https://github.com/TheSoftwareDesignLab/ANTARES/antares-web](https://github.com/TheSoftwareDesignLab/ANTARES/antares-web)
55+

docs/assets/antares-cli.png

6.61 MB
Loading

docs/assets/antares-radar-ui.png

553 KB
Loading
408 KB
Loading

0 commit comments

Comments
 (0)