Sandbox

Python API reference for creating and working with Thunder sandboxes.

Import the thunder package to create a sandbox and run commands in it.

import thunder

Sandbox.create

Creates a new sandbox with the requested compute and storage resources.

sandbox = thunder.Sandbox.create(cpu=4, memory=32, storage=50)

cpu · integer · required

Number of CPU cores to allocate.

memory · integer · required

Amount of memory to allocate.

storage · integer · required

Amount of storage to allocate.

Returns a Sandbox object immediately. Call wait_until_running() before executing commands.

Sandbox.wait_until_running

Waits until the sandbox is ready to accept commands.

sandbox.wait_until_running()

Sandbox.exec

Starts a command in the sandbox. Pass the executable as the first positional argument and each command-line argument separately.

process = sandbox.exec("uname", "-a")

command · string · required

Executable to run in the sandbox.

*args · string

Command-line arguments passed to the executable.

Returns a process object. Read its standard output with process.stdout.read() and wait for it to finish with process.wait().

Process.stdout.read

Reads the command’s standard output.

print(process.stdout.read())

Process.wait

Waits for the command to finish.

process.wait()

Sandbox.terminate

Terminates the sandbox and releases its resources.

sandbox.terminate()

Terminate a sandbox when you no longer need it.