CATS: the Climate-Aware Task Scheduler

A lightweight Python-based tool that calculates the optimal time to run a compute job to minimise its carbon intensity enabling environmentally-conscious scheduling.
https://github.com/GreenScheduler/cats

Category: Emissions
Sub Category: Carbon Intensity and Accounting

Keywords

carbon carbon-footprint climate computing electricity electricity-consumption energy energy-consumption job-scheduler scheduling

Keywords from Contributors

earth-system-model

Last synced: about 9 hours ago
JSON representation

Repository metadata

🐈 CATS: the Climate-Aware Task Scheduler 🌍

README.md

CATS logo

CATS: Climate-Aware Task Scheduler

CATS is a Climate-Aware Task Scheduler. It schedules cluster jobs to minimize predicted carbon intensity of running the process. It was created as part of the 2023 Collaborations Workshop.

The Climate-Aware Task Scheduler is a lightweight Python package designed to schedule tasks based on the estimated carbon intensity of the electricity grid at any given moment. This tool uses real-time carbon intensity data from the National Grid ESO via their API to estimate the carbon intensity of the electricity grid, and schedules tasks at times when the estimated carbon intensity is lowest. This helps to reduce the carbon emissions associated with running computationally intensive tasks, making it an ideal solution for environmentally conscious developers.

Demo showing CATS scheduling a 30 minute job using the at scheduler
CATS animated usage example

[!NOTE]
Currently CATS only works in the UK. If you are aware of APIs for realtime grid carbon intensity data in other countries please open an issue and let us know.

DOI

Features

  • Estimates the carbon intensity of the electricity grid in real-time
  • Schedules tasks based on the estimated carbon intensity, minimizing carbon emissions
  • Provides a simple and intuitive API for developers
  • Lightweight and easy to integrate into existing workflows
  • Supports Python 3.9+

Installation

Install via pip as follows:

pip install climate-aware-task-scheduler

To install the development version:

pip install git+https://github.com/GreenScheduler/cats

Documentation

Documentation is available at https://cats.readthedocs.io

We recommend the
quickstart
if you are new to CATS. CATS can optionally display carbon footprint
savings

using a configuration file.

Contributing

We welcome contributions from the community! If you find a bug or have an idea for a new feature, please open an issue on our GitHub repository or submit a pull request.

License

MIT License

Citation (CITATION.cff)

cff-version: "1.2.0"
authors:
- family-names: Bartholomew
  given-names: Sadie L.
  orcid: "https://orcid.org/0000-0002-6180-3603"
- family-names: Colling
  given-names: Lincoln
  orcid: "https://orcid.org/0000-0002-3572-7758"
- family-names: Dasgupta
  given-names: Abhishek
  orcid: "https://orcid.org/0000-0003-4420-0656"
- family-names: Greenberg
  given-names: Anthony J.
  orcid: "https://orcid.org/0000-0003-3296-5811"
- family-names: Lannelongue
  given-names: Loïc
  orcid: "https://orcid.org/0000-0002-9135-1345"
- family-names: Lestang
  given-names: Thibault
  orcid: "https://orcid.org/0000-0001-6770-2638"
- family-names: Martinez-Ortiz
  given-names: Carlos
  orcid: "https://orcid.org/0000-0001-5565-7577"
- family-names: Sauzé
  given-names: Colin
  orcid: "https://orcid.org/0000-0001-5368-9217"
- family-names: Walker
  given-names: Andrew M.
  orcid: "https://orcid.org/0000-0003-3121-3255"
- family-names: Ward
  given-names: Adam Stuart
  orcid: "https://orcid.org/0009-0008-3463-2694"
contact:
- family-names: Walker
  given-names: Andrew M.
  orcid: "https://orcid.org/0000-0003-3121-3255"
doi: 10.5281/zenodo.15753041
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Bartholomew
    given-names: Sadie L.
    orcid: "https://orcid.org/0000-0002-6180-3603"
  - family-names: Colling
    given-names: Lincoln
    orcid: "https://orcid.org/0000-0002-3572-7758"
  - family-names: Dasgupta
    given-names: Abhishek
    orcid: "https://orcid.org/0000-0003-4420-0656"
  - family-names: Greenberg
    given-names: Anthony J.
    orcid: "https://orcid.org/0000-0003-3296-5811"
  - family-names: Lannelongue
    given-names: Loïc
    orcid: "https://orcid.org/0000-0002-9135-1345"
  - family-names: Lestang
    given-names: Thibault
    orcid: "https://orcid.org/0000-0001-6770-2638"
  - family-names: Martinez-Ortiz
    given-names: Carlos
    orcid: "https://orcid.org/0000-0001-5565-7577"
  - family-names: Sauzé
    given-names: Colin
    orcid: "https://orcid.org/0000-0001-5368-9217"
  - family-names: Walker
    given-names: Andrew M.
    orcid: "https://orcid.org/0000-0003-3121-3255"
  - family-names: Ward
    given-names: Adam Stuart
    orcid: "https://orcid.org/0009-0008-3463-2694"
  date-published: 2025-07-08
  doi: 10.21105/joss.08251
  issn: 2475-9066
  issue: 111
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 8251
  title: "CATS: The Climate Aware Task Scheduler"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.08251"
  volume: 10
title: "CATS: The Climate Aware Task Scheduler"

Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 8 days ago

Total Commits: 434
Total Committers: 13
Avg Commits per committer: 33.385
Development Distribution Score (DDS): 0.751

Commits in past year: 76
Committers in past year: 5
Avg Commits per committer in past year: 15.2
Development Distribution Score (DDS) in past year: 0.447

Name Email Commits
Thibault Lestang t****g@i****k 108
Abhishek Dasgupta a****a@d****k 74
Sadie L. Bartholomew s****w@n****k 73
Andrew Walker a****r@e****k 64
Loïc Lannelongue l****e@p****t 44
Colin Sauze c****e@n****k 26
Adam Ward a****a@n****k 17
Lincoln Colling l****n@c****z 13
Tony Greenberg i****o@b****g 6
isofinly i****y@i****m 5
Carlos Martinez c****z@e****l 2
Nicolas Payette n****e@g****m 1
Andy Turner a****r@e****k 1

Committer domains:


Issue and Pull Request metadata

Last synced: 9 days ago

Total issues: 89
Total pull requests: 121
Average time to close issues: 3 months
Average time to close pull requests: 18 days
Total issue authors: 11
Total pull request authors: 14
Average comments per issue: 1.42
Average comments per pull request: 1.76
Merged pull request: 93
Bot issues: 0
Bot pull requests: 0

Past year issues: 26
Past year pull requests: 48
Past year average time to close issues: 3 months
Past year average time to close pull requests: 11 days
Past year issue authors: 8
Past year pull request authors: 9
Past year average comments per issue: 1.15
Past year average comments per pull request: 1.38
Past year merged pull request: 32
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/GreenScheduler/cats

Top Issue Authors

  • andreww (22)
  • abhidg (20)
  • sadielbartholomew (18)
  • colinsauze (9)
  • mkbane (6)
  • Llannelongue (6)
  • LiamPattinson (3)
  • tlestang (2)
  • elichad (1)
  • ip2location (1)
  • thomasferte (1)

Top Pull Request Authors

  • andreww (39)
  • abhidg (36)
  • tlestang (17)
  • sadielbartholomew (10)
  • Llannelongue (6)
  • colinsauze (2)
  • nicolaspayette (2)
  • aturner-epcc (2)
  • danielskatz (2)
  • isofinly (1)
  • JimCircadian (1)
  • c-martinez (1)
  • ocoodo (1)
  • ljcolling (1)

Top Issue Labels

  • enhancement (12)
  • documentation (10)
  • bug (4)
  • catsV2 (4)
  • question (3)
  • testing (3)
  • carbonIntensityAPI (2)
  • carbonFootprint (2)
  • JOSS requirement (2)
  • refactoring (2)
  • good first issue (1)
  • wrapper (1)
  • timeOptimiser (1)

Top Pull Request Labels

  • documentation (4)
  • enhancement (1)

Package metadata

pypi.org: climate-aware-task-scheduler

Climate aware task scheduler

  • Homepage: https://github.com/GreenScheduler/cats
  • Documentation: https://climate-aware-task-scheduler.readthedocs.io/
  • Licenses: MIT License Copyright (c) 2023 GreenScheduler Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  • Latest release: 1.1.0 (published 6 months ago)
  • Last Synced: 2025-12-10T17:02:23.975Z (16 days ago)
  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 15 Last month
  • Rankings:
    • Dependent packages count: 10.607%
    • Average: 35.17%
    • Dependent repos count: 59.732%
  • Maintainers (2)

Dependencies

.github/workflows/tests.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
pyproject.toml pypi
  • PyYAML >=6.0
  • requests-cache >=1.0

Score: 10.03289168974739