NEST Server -- A Python-based API server for the NEST Simulator

This repository contains a REST-based interface to talk to the NEST Simulator.

Quick start

Install NEST Server with pip

pip install nest-server

Start NEST Server

nest-server start

Command options

Entering nest-server without sub-command prints the documentation:

usage: nest-server [-d] [-h HOST] [-o] [-p PORT] [-t TIMEOUT] [-w WORKERS] {log,pid,start,stop,version}

A Python-based API server for NEST Simulator

positional arguments:
  {log,pid,start,stop,version}

options:
  -d, --daemon          daemonize the server process
  -h, --host HOST       use hostname/IP address <HOST> for the server [default: 127.0.0.1]
  -o, --outputs         print NEST outputs to the console
  -p, --port PORT       use port <PORT> for opening the socket [default: 52425]
  -t, --timeout TIMEOUT
                        workers silent for more than this many seconds are killed and restarted [default: 30]
  -w, --workers WORKERS
                        the number of worker processes for handling requests [default: 1]

Default environment variables

# nest-server
NEST_SERVER_DAEMON=false
NEST_SERVER_HOST="127.0.0.1"
NEST_SERVER_LOGFILE="/tmp/nest-server.log"
NEST_SERVER_PIDFILE="/tmp/nest-server.pid"
NEST_SERVER_PORT=52425
NEST_SERVER_STDOUT=false
NEST_SERVER_TIMEOUT=30
NEST_SERVER_WORKERS=1

# main.py
NEST_SERVER_ACCESS_TOKEN=""
NEST_SERVER_DISABLE_AUTH=false
NEST_SERVER_DISABLE_RESTRICTION=false
NEST_SERVER_CORS_ORIGINS="http://localhost:*,http://127.0.0.1:*"
NEST_SERVER_ENABLE_EXEC_CALL=false
NEST_SERVER_MODULES="import nest"

Development mode

We recommend to use virtual environment, e.g. with uv:

Install nest-server as an editable package

uv pip install -e .

Run nest-server

uv run nest-server start

References

Documentation
NEST Simulator via its REST-based interface

Release files for nest-server 3.0.0b3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for nest-server 3.0.0b3
File	Size	Uploaded
nest_server-3.0.0b3.tar.gz	20.4 kB	Sep 10, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for nest-server 3.0.0b3
File	Interpreter	ABI	Platform	Reset
nest_server-3.0.0b3-py3-none-any.whl 30.5 kB Sep 10, 2026	Python 3	none	any	Details

Total release size: 50.9 kB

Release files / nest_server-3.0.0b3.tar.gz

Download URL	nest_server-3.0.0b3.tar.gz
Size	20.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`238478390ab2a47159034c3fe9d8f9c8ca2a78217bc2becf9b707dd8583abb5e`
BLAKE2b-256 checksum How to use checksums	`6a4f876458eb05459e9f061ad74359c80fd7e12acfe4e2aca832645c66fd5085`
Upload date	Sep 10, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.12`

Release files / nest_server-3.0.0b3-py3-none-any.whl

Download URL	nest_server-3.0.0b3-py3-none-any.whl
Size	30.5 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`5435e9a8f54a1901ea8df961658757493a0365c9dd618086cd1e2e6b09e0ddc4`
BLAKE2b-256 checksum How to use checksums	`d3f736c392e38198890788ca7e6e42bde608f9aacb0389d6c01d657f75a0f380`
Upload date	Sep 10, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.12`