OBSERVATORY_MAX_NATIVE_THREADS

Reference · Environment · Documentation

Updated

Browse documentation
On this page

Earlier command and setup reference · Engine 18.6.0rc590 / Reader 8.11.0rc649

Definition

A positive integer that caps Polars and BLAS threads.

Set a deliberate thread cap

For a POSIX shell, this runs one command with a cap of four native threads:

OBSERVATORY_MAX_NATIVE_THREADS=4 observatory run observatory.yaml

The setting accepts a positive integer. Use a value such as 1 or 4; zero, a negative number and a word such as auto do not satisfy that contract.

Compare with the same workload

When choosing a cap, compare runs with the same configuration and source files. Record both elapsed time and resource use on the machine that will run the analysis. This variable caps Polars and BLAS threads. A higher cap does not guarantee a faster run, and the cap does not limit every activity in the process.