Command-line (CLI) reference

A climate aware job scheduler

usage: cats [-h] -d DURATION [-a API] [-l LOCATION] [--config CONFIG]
            [--jobinfo JOBINFO]

Named Arguments

-d, --duration

[required] Expected duration of the job in minutes.

-a, --api

Which API should be used to obtain carbon intensity forecasts. Overrides config.yml. For now, only choice is ‘carbonintensity.org.uk’ (UK only) (default: ‘carbonintensity.org.uk’)

-l, --location

Location of the computing facility. For the UK, first half of a postcode (e.g. ‘M15’), for other APIs, see doc for exact format. Overrides config.yml. If absent, location based in IP address is used.

--config

Path to a config file, default is config.yml in current directory. Config file is required to obtain carbon footprint estimates. template at https://github.com/GreenScheduler/cats/blob/main/config.yml

--jobinfo

Resources used by the job in question, used to estimate total energy usage and carbon footprint. E.g. ‘cpus=2,gpus=0,memory=8,partition=CPU_partition’. cpus: number of CPU cores, gpus: number of GPUs, memory: memory available in GB, partition: one of the partitions keys in config.yml.