This release is a pre-release and may not be stable for production use.
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
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file nest_server-3.0.0b2.tar.gz.
File metadata
- Download URL: nest_server-3.0.0b2.tar.gz
- Upload date:
- Size: 19.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
196e3fcaa955ec7a3f7608c5a004307c95c04e05936edf8c6d5705a2a1fe545b
|
|
| MD5 |
06a865ebcef7ffe991de1574d6106ef3
|
|
| BLAKE2b-256 |
c713f0fd2982f7141da10b7b137a932d3a5d3991ea94e234796266081c44e15d
|
File details
Details for the file nest_server-3.0.0b2-py3-none-any.whl.
File metadata
- Download URL: nest_server-3.0.0b2-py3-none-any.whl
- Upload date:
- Size: 24.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8a29d4f225396b8e4eefa4ae635fa9171dc65eb649ba300d7d375c020e52a8b5
|
|
| MD5 |
16a08fdcc7f760167095bd1e6d0abdf0
|
|
| BLAKE2b-256 |
41aa3a19e3d954458ac789b52aa2ee1c22ac457edfa48e7a28272c69a7250926
|
