Docker

SciNumTools provides Dockerfiles for a ready-to-use Python environment, a reproducible development environment, and the REST API server. Build an image from the repository root, which also supplies the source tree as the Docker build context. The checkout must include its Git submodules.

Python environment

Build an image for running Python code with SciNumTools installed:

docker build \
    -f packaging/docker/python/Dockerfile \
    -t scinumtools3-python .

Development environment

Build an image containing the toolchain and dependencies used to develop SciNumTools:

docker build \
    -f packaging/docker/dev/Dockerfile \
    -t scinumtools3-dev .

Containers are useful for repeatable builds and for environments where installing the complete native toolchain locally would be inconvenient.

REST API server

Build the image containing snt with server support and its native runtime dependencies:

docker build \
    -f packaging/docker/rest/Dockerfile \
    -t scinumtools3-rest .

Run it as a network service:

docker run --rm -p 8080:8080 scinumtools3-rest

The container listens on all of its own interfaces and Docker publishes port 8080 on the host. The API has no authentication; production deployment must place it behind appropriate network access controls or an authentication-capable reverse proxy. To restrict it to the Docker host while developing, use -p 127.0.0.1:8080:8080 instead. See REST API server for endpoints and request formats.

Published parameter environment

Mount a DIPL project directory read-only and publish the environment parsed from its DIPfile at startup:

docker run --rm -p 9000:8080 \
    -v "$(pwd)/model:/data:ro" \
    scinumtools3-rest \
    --project model=/data/DIPfile

The service is then available on port 9000. It never receives the project files over HTTP; it parses the mounted project once and exposes the immutable result under the name model. A mounted DIPH5 environment works similarly:

docker run --rm -p 9000:8080 \
    -v "$(pwd)/environment.diph5:/data/environment.diph5:ro" \
    scinumtools3-rest \
    --diph5 model=/data/environment.diph5