.env.example

# =============================================================================
# Required Environment Variables
# =============================================================================
# These must be set before starting the backend server.

# Tiled Server URL
# The base URL for the Tiled data server providing scan data.
SCATTERING_TILED_URL="http://tiled:8888/api/v1"

# Tiled API Key
# Authentication token for accessing the Tiled server.
SCATTERING_TILED_API_KEY="your_api_key_here"

# =============================================================================
# Optional Environment Variables (with defaults)
# =============================================================================
# These have sensible defaults but can be tuned for your environment.

# -----------------------------------------------------------------------------
# Save Results to Tiled (Optional Feature)
# -----------------------------------------------------------------------------
# When set, a "Save to Tiled" button appears in the UI, allowing users to
# save linecut and batch processing results to a writable Tiled container.
# If not set, the feature is disabled and no save buttons are shown.

# URL of the writable Tiled container for saving results.
# Use the metadata path to target a specific container, e.g.:
#   http://tiled:8888/api/v1/metadata/results
# Or use the bare API URL to write to the root:
#   http://tiled:8888/api/v1
# SCATTERING_TILED_RESULTS_URL="http://tiled:8888/api/v1/metadata/results"

# API key for the results Tiled server.
# SCATTERING_TILED_RESULTS_API_KEY="your_results_api_key_here"

# -----------------------------------------------------------------------------
# Calibration Tiled Server (Optional Feature)
# -----------------------------------------------------------------------------
# When set, calibration parameters and masks can be loaded from a dedicated
# Tiled server. If not set, calibration loading from Tiled is disabled and
# users must enter calibration parameters manually or upload mask files.

# URL of the Tiled server containing calibration data (PONI files and masks).
# SCATTERING_TILED_CALIBRATION_URL="http://tiled-calibration:8888/api/v1"

# API key for the calibration Tiled server.
# SCATTERING_TILED_CALIBRATION_API_KEY="your_calibration_api_key_here"

# -----------------------------------------------------------------------------
# Server Configuration
# -----------------------------------------------------------------------------

# Development mode enables hot reload (default: false)
# Set to true for local development, false for production/Docker.
# SCATTERING_BACKEND_DEVELOPMENT=false

# Backend server host address (default: 0.0.0.0)
# Use 0.0.0.0 to accept connections from any interface.
# SCATTERING_BACKEND_HOST=0.0.0.0

# Backend server port (default: 8000)
# SCATTERING_BACKEND_PORT=8000

# -----------------------------------------------------------------------------
# Cache Configuration
# -----------------------------------------------------------------------------
# Larger cache sizes improve performance but use more memory.
# Each cached image is ~10-50MB depending on detector size.

# Maximum number of processed images to cache (default: 50)
# SCATTERING_BACKEND_CACHE_IMAGE_SIZE=50

# Maximum number of Q-space matrices to cache (default: 20)
# Q-matrices are reused when only linecut parameters change.
# SCATTERING_BACKEND_CACHE_QSPACE_SIZE=20

# Maximum number of GISAXS transforms to cache (default: 20)
# SCATTERING_BACKEND_CACHE_GISAXS_SIZE=20

# Maximum number of masks to cache per cache type (default: 50)
# Applies to both Tiled masks and uploaded masks separately.
# SCATTERING_BACKEND_CACHE_MASK_SIZE=50

# Maximum number of Tiled URI client connections to cache (default: 4)
# SCATTERING_BACKEND_CACHE_TILED_URIS=4

# -----------------------------------------------------------------------------
# Batch Processing Configuration
# -----------------------------------------------------------------------------

# Maximum number of parallel workers for batch processing (default: 16)
# Higher values improve throughput but increase memory usage.
# Recommended: Set to number of CPU cores or slightly higher for I/O-bound work.
# SCATTERING_BACKEND_BATCH_MAX_WORKERS=16

# -----------------------------------------------------------------------------
# Logging Configuration
# -----------------------------------------------------------------------------

# Log level for application logging (default: INFO)
# Valid values: DEBUG, INFO, WARNING, ERROR, CRITICAL
# Use DEBUG for development, INFO or WARNING for production.
# SCATTERING_BACKEND_LOG_LEVEL=INFO