Add ANTARES source code and docs

Author: jsurrea

.gitignore

@@ -0,0 +1,3 @@
+# Mac OS
+.DS_Store
+

README.md

@@ -0,0 +1,105 @@
+# ANTARES: A Software-Based Tool for Simulating Naval Radar Operations
+
+This repository contains the source code for ANTARES, a comprehensive naval radar simulation system designed to meet the operational needs of maritime security and training for the Colombian Navy. The system combines cutting-edge technology with modular and extensible architecture, providing a robust solution for naval simulation, real-time visualization, and tactical evaluation.
+
+## 🚢 **Project Overview**
+
+### **Introduction**
+
+The project is aimed at developing an advanced naval radar simulator, capable of real-time detection, monitoring, and tracking of vessels in a simulated maritime environment. It supports realistic training, mission planning, and operational readiness, enhancing the Colombian Navy's capabilities and positioning it as a regional leader in naval technology.
+
+### **Objective**
+
+- To design and implement a radar simulation system for generating and visualizing real-time data on vessel positions and movements in a simulated naval setting.
+
+## 📂 **Repository Structure**
+
+The repository is divided into three major components, each with its own dedicated subdirectory and README file for further details:
+
+### 1. **[Naval Radar Simulator](./naval-radar-simulator)**
+
+- Implements the radar simulation engine, responsible for generating radar data in real-time.
+- Developed in **Rust**, prioritizing:
+  - High performance.
+  - Security and low-level control.
+  - Configurability via TOML configuration files.
+- Real-time data is transmitted using TCP sockets.
+- Modular design supports extensibility for new features such as movement patterns, physical conditions, and custom tracking algorithms.
+
+**Instructions to Run**:
+
+```bash
+cd naval-radar-simulator
+cargo run -- <config-file>
+```
+
+Replace `<config-file>` with the path to the desired TOML configuration file. Further setup instructions can be found in the subdirectory's [README](./naval-radar-simulator/README.md).
+
+### 2. **[Naval Radar Web UI](./naval-radar-web-ui)**
+
+- A **React-based user interface** for visualizing radar data.
+- Features include:
+  - Real-time radar display with panning and zoom functionality.
+  - Chat and control interface for interacting with the radar simulation.
+  - Communication with the radar engine using WebSockets.
+
+**Instructions to Run**:
+
+```bash
+cd naval-radar-web-ui
+npm install
+npm start
+```
+
+Open the interface in your browser at `http://localhost:5173`. Detailed information is available in the subdirectory's [README](./naval-radar-web-ui/README.md).
+
+### 3. **[Naval Radar Reverse Proxy](./naval-radar-reverse-proxy)**
+
+- Handles WebSocket connections between the web UI and radar simulation engine.
+- Ensures secure and optimized data transfer.
+- Configured to work seamlessly with both the simulation and web UI components.
+
+**Instructions to Run**:
+
+```bash
+cd naval-radar-reverse-proxy
+npm install
+npm start
+```
+
+Configuration details can be found in the subdirectory's [README](./naval-radar-reverse-proxy/README.md).
+
+## 🔧 **Key Features**
+
+- **Real-Time Radar Simulation**: Sub-10ms latency for precise real-time data.
+- **Extensibility**: Modular architecture allows integration of new entities and algorithms.
+- **Secure Communication**: Data is transmitted securely via standardized TCP and WebSocket protocols.
+- **Intuitive User Interface**: A highly interactive, user-friendly web interface for visualization and control.
+- **High Performance**: Built in Rust for efficient handling of radar computations and data streaming.
+
+## 📊 **Results and Impact**
+
+The simulator achieves its objectives by:
+
+1. Offering real-time, precise radar tracking.
+2. Providing extensibility for future needs, including new physical conditions and tracking enhancements.
+3. Meeting the operational training requirements of the Colombian Navy.
+
+**System Performance**:
+
+- Sub-10ms latency for seamless real-time updates.
+- Modular components ensure flexibility and scalability.
+
+## 📜 **References**
+
+For further information on specific components, refer to the README files located in their respective directories:
+
+- [Naval Radar Simulator](./naval-radar-simulator/README.md)
+- [Naval Radar Web UI](./naval-radar-web-ui/README.md)
+- [Naval Radar Reverse Proxy](./naval-radar-reverse-proxy/README.md)
+
+## 📥 **Contributions**
+
+This project was developed by **Juan Sebastian Urrea Lopez** as part of research initiatives at **Universidad de los Andes**, in collaboration with the **Armada de la República de Colombia**.
+
+For any contributions, suggestions, or issues, feel free to open a pull request or contact the authors directly.

docs/.gitignore

@@ -0,0 +1,6 @@
+_site
+.sass-cache
+.jekyll-cache
+.jekyll-metadata
+vendor
+Gemfile.lock

docs/404.html

@@ -0,0 +1,25 @@
+---
+permalink: /404.html
+layout: default
+---
+
+<style type="text/css" media="screen">
+  .container {
+    margin: 10px auto;
+    max-width: 600px;
+    text-align: center;
+  }
+  h1 {
+    margin: 30px 0;
+    font-size: 4em;
+    line-height: 1;
+    letter-spacing: -1px;
+  }
+</style>
+
+<div class="container">
+  <h1>404</h1>
+
+  <p><strong>Page not found :(</strong></p>
+  <p>The requested page could not be found.</p>
+</div>

docs/Gemfile

@@ -0,0 +1,33 @@
+source "https://rubygems.org"
+# Hello! This is where you manage which Jekyll version is used to run.
+# When you want to use a different version, change it below, save the
+# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
+#
+#     bundle exec jekyll serve
+#
+# This will help ensure the proper Jekyll version is running.
+# Happy Jekylling!
+# gem "jekyll", "~> 4.4.1"
+# This is the default theme for new Jekyll sites. You may change this to anything you like.
+gem "minima", "~> 2.5"
+# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
+# uncomment the line below. To upgrade, run `bundle update github-pages`.
+gem "github-pages", "~> 232", group: :jekyll_plugins
+# If you have any plugins, put them here!
+group :jekyll_plugins do
+  gem "jekyll-feed", "~> 0.12"
+end
+
+# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
+# and associated library.
+platforms :mingw, :x64_mingw, :mswin, :jruby do
+  gem "tzinfo", ">= 1", "< 3"
+  gem "tzinfo-data"
+end
+
+# Performance-booster for watching directories on Windows
+gem "wdm", "~> 0.1", :platforms => [:mingw, :x64_mingw, :mswin]
+
+# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
+# do not have a Java counterpart.
+gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]

docs/_config.yml

@@ -0,0 +1,58 @@
+# Welcome to Jekyll!
+#
+# This config file is meant for settings that affect your whole blog, values
+# which you are expected to set up once and rarely edit after that. If you find
+# yourself editing this file very often, consider using Jekyll's data files
+# feature for the data you need to update frequently.
+#
+# For technical reasons, this file is *NOT* reloaded automatically when you use
+# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
+#
+# If you need help with YAML syntax, here are some quick references for you:
+# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml
+# https://learnxinyminutes.com/docs/yaml/
+#
+# Site settings
+# These are used to personalize your new site. If you look in the HTML files,
+# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
+# You can create any custom variable you would like, and they will be accessible
+# in the templates via {{ site.myvariable }}.
+
+# Read more at https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll
+# Use bundle exec jekyll serve --baseurl="" to test locally
+
+title: "ANTARES"
+email: [email protected]
+description: >- # this means to ignore newlines until "baseurl:"
+  A Software-Based Tool for Simulating Naval Radar Operations
+domain: "thesoftwaredesignlab.github.io"
+baseurl: "/ANTARES/" # the subpath of your site, e.g. /blog
+url: "https://thesoftwaredesignlab.github.io" # the base hostname & protocol for your site, e.g. http://example.com
+github_username:  TheSoftwareDesignLab
+show_downloads: false
+
+# Build settings
+remote_theme: pages-themes/[email protected]
+plugins:
+  - jekyll-feed
+  - jekyll-remote-theme
+
+# Exclude from processing.
+# The following items will not be processed, by default.
+# Any item listed under the `exclude:` key here will be automatically added to
+# the internal "default list".
+#
+# Excluded items can be processed by explicitly listing the directories or
+# their entries' file path in the `include:` list.
+#
+# exclude:
+#   - .sass-cache/
+#   - .jekyll-cache/
+#   - gemfiles/
+#   - Gemfile
+#   - Gemfile.lock
+#   - node_modules/
+#   - vendor/bundle/
+#   - vendor/cache/
+#   - vendor/gems/
+#   - vendor/ruby/

docs/index.markdown

@@ -0,0 +1,82 @@
+---
+layout: default
+title: ANTARES
+permalink: /
+---
+
+ANTARES is an open-source, software-based naval radar simulator. ANTARES is designed for seamless integration with other systems via the TCP protocol while also supporting standalone operation through a Graphical User Interface (GUI). It adheres to the open-closed design principle, facilitating easy extensibility with new simulation entities, such as naval vessel movement strategies. The simulator is implemented using the Rust programming language due to its advantages in performance, type safety, concurrency, and memory safety.
+
+# 🚀 **Getting Started**
+
+## **Installation and Setup**
+
+To install ANTARES from source, follow these steps:
+
+1. Install Rust and Cargo:
+   - If you haven't already, install Rust and Cargo by following the instructions on the [Rust website](https://www.rust-lang.org/tools/install).
+2. Clone the repository from GitHub and navigate to the project directory:
+```bash
+git clone https://github.com/TheSoftwareDesignLab/ANTARES.git
+cd ANTARES
+```
+3. Build the project:
+```bash
+cargo build --release --manifest-path=naval-radar-simulator/Cargo.toml
+```
+
+Alternatively, you can download the compiled files from the project's repository.
+
+## **Running the Simulator**
+
+You will need a configuration file to run the simulator. The configuration file is in TOML format and defines the radar's parameters, simulation settings, and environment details. A sample configuration file is provided in the `config` directory. You can modify this file to suit your needs.
+```toml
+[radar]
+
+[radar.protocol]
+host = "0.0.0.0"
+num_workers_tci = 4
+num_workers_tdi = 4
+
+[radar.detector]
+range = 100.0
+speed = 5.0
+angle = 3.14
+start_coordinates = [4.0, -72.0]
+
+[simulation]
+emission_interval = 20
+
+[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] }]
+```
+
+To run the simulator, use the following command:
+```bash
+naval-radar-simulator/target/release/naval-radar-simulator <config-file>
+```
+Replace `<config-file>` with the path to your TOML configuration file.
+
+## **Running the GUI**
+
+We need a reverse proxy to forward the TCP connection to the GUI through a websocket connection. Run the following commands in a new terminal to start the reverse proxy:
+```bash
+cd naval-radar-reverse-proxy
+npm install
+npm start
+```
+
+The reverse proxy will listen on port 8080 by default. You can change the port by modifying the `WEBSOCKET_PORT` variable in the `.env` file.
+
+To run the GUI, use the following commands in a new terminal:
+
+```bash
+cd naval-radar-web-ui
+npm install
+npm run dev
+```
+
+The GUI will be available at `http://localhost:5173`
+

naval-radar-reverse-proxy/.env

@@ -0,0 +1 @@
+WEBSOCKET_PORT=8080

naval-radar-reverse-proxy/.gitignore

@@ -0,0 +1,3 @@
+# npm
+node_modules
+package-lock.json