Introduction

This guide covers everything needed to deploy and operate NeuroSim Core in your environment. It is intended for system administrators and DevOps engineers responsible for standing up and maintaining the platform.

In This Section

PageTopics
PrerequisitesApache Kafka, PostgreSQL — what to install and how to configure each for NeuroSim
InstallationObtaining NeuroSim Core, running it as a binary or container
ConfigurationComplete reference for the YAML configuration file and environment variable overrides

Administration Overview

NeuroSim Core facilitates composing and configuring scenarios, and orchestrating runs of those scenarios. NeuroSim Core is a single stateless binary (ns-core) that:

  • Serves a REST API and embedded web UI on a configurable HTTP port (default 8080)
  • Uses Apache Kafka as its message bus for both control plane and data plane traffic
  • Persists scenario definitions and run history to PostgreSQL; run messages remain in Aoache Kafka and can be migrated to longer-term storage using Kafka Tiered Storage.

A valid license JWT file must be present on startup and it is validated every hour thereafter.

All three external dependencies — Kafka, PostgreSQL, and the license file — must be in place before Core will start successfully.