Update simulator

Author: jsurrea

antares/Cargo.lock

@@ -11,8 +11,15 @@ async-trait = "0.1.88"
 tokio-tungstenite = "0.26.2"
 futures-util = "0.3.31"
 futures = "0.3.31"
-axum = "0.8.4"
+axum = { version = "0.8.4", features = [
+    "json",
+    "macros",
+    "tokio",
+    "http1",
+    "tower-log",
+] }
 tokio = { version = "1", features = ["full"] }
 hyper = { version = "1", features = ["full"] }
 serde = { version = "1", features = ["derive"] }
 clap = { version = "4.5.37", features = ["derive"] }
+tower-http = { version = "0.6.2", features = ["cors"] }

antares/Cargo.toml

@@ -1,151 +1,62 @@
-# Naval Radar - Simulator
+# Antares Simulator
 
-The Naval Radar Simulator is a robust project designed to simulate radar systems, generate radar data, and emulate real-world scenarios involving radar detection and tracking.
+**Antares** is a high-performance simulation engine for naval radar scenarios, written in Rust. It generates dynamic environments with ships, emitters, and wave conditions, and feeds simulated radar data to subscribers via TCP and WebSocket. The simulator is designed for modular experimentation, real-time control, and seamless integration with visualization tools such as [Antares Web](https://thesoftwaredesignlab.github.io/ANTARES/antares-web).
 
-## **Features**
+## Prerequisites
 
-- **Configurable Radar Simulation**:
-  - Define radar parameters like range, resolution, and target detection.
-- **Dynamic Simulation**:
-  - Simulates target movements (linear, random, circular, stationary) and environmental effects.
-- **Communication Protocol**:
-  - Implements TCP interfaces for communication between radar components.
-- **Realistic Tracking**:
-  - Includes tracking algorithms for managing targets.
+Make sure you have [Rust](https://www.rust-lang.org/tools/install) installed. You can install Rust and Cargo using:
 
-## **Setup Instructions**
-
-1. **Install Rust**
-   Make sure you have Rust and cargo installed. If not, you can install them following the instructions on the [Rust website](https://www.rust-lang.org/tools/install).
-
-2. **Go to the Project Directory**
-
-   ```bash
-   cd naval-radar-simulator
-   ```
-
-3. **Build the Project**
-   There are 2 ways to build the project:
-
-   - **Development Build**:
-     ```bash
-     cargo build
-     ```
-   - **Release Build**:
-     ```bash
-     cargo build --release
-     ```
-
-   It is recommended to use the release build for better performance. Use the development build for debugging and testing.
-
-4. **Run the Simulator**
-   Run the simulator with a configuration file:
-
-   For the release build:
+```bash
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+```
 
-   ```bash
-    ./target/release/naval-radar-simulator <config-file>
-   ```
+## Running the Simulator
 
-   For the development build:
+To launch the simulator with the default settings:
 
-   ```bash
-   cargo run -- <config-file>
-   ```
+```bash
+cargo run
+```
 
-   Replace `<config-file>` with the path to your TOML configuration file.
+To run the simulator with a custom configuration:
 
-## **Configuration File**
+```bash
+cargo run -- --config path/to/config.toml
+```
 
-The simulator uses a TOML configuration file to define settings such as radar range, simulation parameters, and environment details. A sample configuration file might look like this:
+You can use `config.example.toml` as a starting point.
 
-```toml
-[radar]
+## Building for Release
 
-[radar.protocol]
-host = "0.0.0.0"
-num_workers_tci = 1
-num_workers_tdi = 1
+For optimized builds suitable for production or deployment:
 
-[radar.detector]
-range = 100.0
-speed = 10.0
-angle = 0.0
-start_coordinates = [4.0, -72.0]
+```bash
+cargo build --release
+```
 
-[simulation]
-emission_interval = 20
+## Project Structure
 
-[simulation.ships]
-line = [{ initial_position = [-50.0, 50.0], angle = 0.785, speed = 5.0 }]
-circle = [{ initial_position = [50.0, -50.0], radius = 20.0, speed = 5.0 }]
-random = [{ initial_position = [-50.0, -50.0], max_speed = 20.0 }]
-stationary = [{ initial_position = [50.0, 50.0] }]
 ```
-
-## **Directory Structure**
-
-The directory structure organizes the project for clarity and scalability:
-
-```plaintext
-src
-├── config.rs           # Manages configuration structures and settings
-├── controller.rs       # Manages the Controller struct, starting the radar and simulation
-├── lib.rs              # Main library file with module definitions
-├── main.rs             # Entry point for the simulator
-├── radar/              # Radar simulation logic
-│   ├── config.rs       # Configuration for radar-specific settings
-│   ├── detector/       # Radar detection logic
-│   │   ├── detector.rs # Core detection algorithms
-│   │   ├── mod.rs      # Detector module entry point
-│   │   └── plot.rs     # Handles radar plot generation
-│   ├── mod.rs          # Radar module entry point
-│   ├── protocol/       # Radar communication protocol
-│   │   ├── constants/  # Constants used in protocol definitions
-│   │   │   ├── client_command.rs
-│   │   │   ├── error_message.rs
-│   │   │   ├── interface_ports.rs
-│   │   │   ├── mod.rs
-│   │   │   └── server_command.rs
-│   │   ├── mod.rs      # Protocol module entry point
-│   │   └── tcp_interfaces/
-│   │       ├── base_track_interface.rs
-│   │       ├── mod.rs
-│   │       ├── track_control_interface.rs
-│   │       └── track_data_interface.rs
-│   ├── radar.rs        # Core radar logic
-│   └── tracker/        # Radar tracking algorithms
-│       ├── mod.rs
-│       ├── track.rs
-│       └── tracker.rs
-├── simulation/         # Simulation logic for the radar
-│   ├── config.rs       # Configuration for the simulation module
-│   ├── emitters/       # Handles simulated emitters like ships or targets
-│   │   ├── emitter.rs
-│   │   ├── mod.rs
-│   │   └── ship.rs
-│   ├── environment/    # Simulated environmental effects
-│   │   ├── mod.rs
-│   │   └── wave.rs
-│   ├── mod.rs          # Simulation module entry point
-│   ├── movement/       # Movement strategies for targets
-│   │   ├── circle.rs
-│   │   ├── line.rs
-│   │   ├── mod.rs
-│   │   ├── random.rs
-│   │   ├── stationary.rs
-│   │   └── strategy.rs
-│   └── simulation.rs   # Core simulation logic
-└── utils/              # Utility functions and reusable structures
-    ├── escape_ascii.rs # ASCII character processing utilities
-    ├── mod.rs          # Utils module entry point
-    └── thread_pool.rs  # Thread pool implementation for concurrency
+antares/
+├── src/                     # Source code
+│   ├── config.rs            # Global configuration loader
+│   ├── controller.rs        # Simulation runtime controller
+│   ├── main.rs              # Entry point
+│   ├── radar/               # Radar logic and broadcasting
+│   │   ├── detector/        # Radar detection and plotting
+│   │   ├── tracker/         # Track generation and filtering
+│   │   ├── broadcaster/     # Data output via TCP/WebSocket
+│   ├── simulation/          # Simulation models
+│   │   ├── emitters/        # Emitter and ship definitions
+│   │   ├── environment/     # Environmental effects (e.g. waves)
+│   │   ├── movement/        # Movement patterns and strategies
+│   │   └── simulation.rs    # Simulation loop
+├── Cargo.toml               # Project metadata and dependencies
+└── Cargo.lock               # Version lockfile
 ```
 
-## **Other Dependencies**
+## Learn More
+
+For demos, examples, and system overview, visit the official platform website:
+👉 [https://thesoftwaredesignlab.github.io/ANTARES/antares-simulator](https://thesoftwaredesignlab.github.io/ANTARES/antares-simulator)
 
-- **`chrono`**: Handles date and time functionality.
-- **`rand`**: Generates random numbers for simulation randomness.
-- **`serde` and `serde_derive`**: Serializes and deserializes data structures.
-- **`toml`**: Parses TOML configuration files.
-- **`std::thread`**: For multi-threaded processing.

antares/README.md

@@ -0,0 +1,48 @@
+# ============================
+# Antares Simulation Config
+# ============================
+
+[antares.simulation]
+emission_interval = 20
+controller_bind_addr = "0.0.0.0:17394"
+
+# ============================
+# Ships to add at startup
+# ============================
+
+[[antares.simulation.initial_ships]]
+type = "line"
+initial_position = [0.0, 0.0]
+angle = 0.785                 # radians (approx. 45 degrees)
+speed = 5.0
+
+[[antares.simulation.initial_ships]]
+type = "circle"
+initial_position = [30.0, -30.0]
+radius = 20.0
+speed = 4.0
+
+[[antares.simulation.initial_ships]]
+type = "random"
+initial_position = [-20.0, 20.0]
+max_speed = 10.0
+
+[[antares.simulation.initial_ships]]
+type = "stationary"
+initial_position = [50.0, 50.0]
+
+# ============================
+# Antares Radar Config
+# ============================
+
+[antares.radar]
+bind_addr = "0.0.0.0:17396"
+
+[antares.radar.detector]
+range = 1000.0
+speed = 0.0
+angle = 0.0
+start_coordinates = [4.0, -72.0]
+
+[antares.radar.broadcast]
+type = "tcp"

antares/config.example.toml

@@ -5,19 +5,15 @@
 //!
 
 use super::{RadarConfig, SimulationConfig};
-use serde::Deserialize;
+use serde::{Deserialize, Serialize};
 
-#[derive(Debug, Deserialize)]
+#[derive(Serialize, Deserialize, Debug, Default, Clone)]
 pub struct Config {
-    pub simulation: SimulationConfig,
-    pub radar: RadarConfig,
+    pub antares: AntaresConfig,
 }
 
-impl Default for Config {
-    fn default() -> Self {
-        Self {
-            simulation: SimulationConfig::default(),
-            radar: RadarConfig::default(),
-        }
-    }
+#[derive(Serialize, Deserialize, Debug, Default, Clone)]
+pub struct AntaresConfig {
+    pub simulation: SimulationConfig,
+    pub radar: RadarConfig,
 }

antares/src/config.rs

@@ -8,15 +8,17 @@ use std::sync::Arc;
 use tokio::sync::mpsc;
 
 pub struct Controller {
+    config: Config,
     radar: Arc<Radar>,
     simulation: Arc<Simulation>,
 }
 
 impl Controller {
     pub fn new(config: Config) -> Controller {
         Controller {
-            radar: Arc::new(Radar::new(config.radar)),
-            simulation: Arc::new(Simulation::new(config.simulation)),
+            config: config.clone(),
+            radar: Arc::new(Radar::new(config.antares.radar)),
+            simulation: Arc::new(Simulation::new(config.antares.simulation)),
         }
     }
 
@@ -42,4 +44,8 @@ impl Controller {
     pub fn add_ship(&self, ship_data: ShipConfig) {
         self.simulation.add_ship(ship_data);
     }
+
+    pub fn get_config(&self) -> Config {
+        self.config.clone()
+    }
 }