Configuration

Create a configuration file to define your organization's research groups and optionally specify the data directory. The configuration file is searched in the following locations:

1. $XDG_CONFIG_HOME/slurm-usage/config.yaml
2. ~/.config/slurm-usage/config.yaml
3. /etc/slurm-usage/config.yaml

Data Directory

The data directory for storing collected metrics can be configured in three ways (in order of priority):

1. Command line: Use --data-dir /path/to/data with any command (highest priority)

2. Configuration file: Set data_dir: /path/to/data in the config file

3. Default: If not specified, data is stored in ./data (current working directory)

This allows flexible deployment: - Default installation: Data stored in ./data subdirectory - System-wide deployment: Set data_dir: /var/lib/slurm-usage in /etc/slurm-usage/config.yaml - Shared installations: Use a network storage path in the config - Per-run override: Use --data-dir flag to override for specific commands

Example config.yaml:

# Example configuration file for slurm-usage
# Copy this file to one of the following locations:
#   - $XDG_CONFIG_HOME/slurm-usage/config.yaml
#   - ~/.config/slurm-usage/config.yaml
#   - /etc/slurm-usage/config.yaml (for system-wide configuration)

# Group configuration - organize users into research groups
groups:
  physics:
    - alice
    - bob
    - charlie
  chemistry:
    - david
    - eve
    - frank
  biology:
    - grace
    - henry
    - irene

# Data directory configuration (optional)
# - If not specified or set to null, defaults to ./data (current working directory)
# - Set to an explicit path to use a custom location
# - Useful for shared installations where data should be stored centrally
#
# Examples:
# data_dir: null                    # Use default ./data directory
# data_dir: /var/lib/slurm-usage    # System-wide data directory
# data_dir: /shared/slurm-data      # Shared network location

Create a configuration file to define your organization's research groups and optionally specify the data directory. The configuration file is searched in the following locations:

1. $XDG_CONFIG_HOME/slurm-usage/config.yaml
2. ~/.config/slurm-usage/config.yaml
3. /etc/slurm-usage/config.yaml

Data Directory

The data directory for storing collected metrics can be configured in three ways (in order of priority):

1. Command line: Use --data-dir /path/to/data with any command (highest priority)

2. Configuration file: Set data_dir: /path/to/data in the config file

3. Default: If not specified, data is stored in ./data (current working directory)

This allows flexible deployment: - Default installation: Data stored in ./data subdirectory - System-wide deployment: Set data_dir: /var/lib/slurm-usage in /etc/slurm-usage/config.yaml - Shared installations: Use a network storage path in the config - Per-run override: Use --data-dir flag to override for specific commands

Example config.yaml:

# Example configuration file for slurm-usage
# Copy this file to one of the following locations:
#   - $XDG_CONFIG_HOME/slurm-usage/config.yaml
#   - ~/.config/slurm-usage/config.yaml
#   - /etc/slurm-usage/config.yaml (for system-wide configuration)

# Group configuration - organize users into research groups
groups:
  physics:
    - alice
    - bob
    - charlie
  chemistry:
    - david
    - eve
    - frank
  biology:
    - grace
    - henry
    - irene

# Data directory configuration (optional)
# - If not specified or set to null, defaults to ./data (current working directory)
# - Set to an explicit path to use a custom location
# - Useful for shared installations where data should be stored centrally
#
# Examples:
# data_dir: null                    # Use default ./data directory
# data_dir: /var/lib/slurm-usage    # System-wide data directory
# data_dir: /shared/slurm-data      # Shared network location