CATS
CATS: The Climate Aware Task Scheduler - Published in JOSS (2025)
Science Score: 95.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 1 DOI reference(s) in JOSS metadata -
○Academic publication links
-
✓Committers with academic emails
7 of 12 committers (58.3%) from academic institutions -
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Keywords
Repository
CATS: the Climate-Aware Task Scheduler 🐈 🐈⬛
Basic Info
- Host: GitHub
- Owner: GreenScheduler
- License: mit
- Language: Python
- Default Branch: main
- Homepage: https://cats.readthedocs.io/
- Size: 8.89 MB
Statistics
- Stars: 72
- Watchers: 6
- Forks: 10
- Open Issues: 32
- Releases: 4
Topics
Metadata Files
README.md
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.
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.
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:
bash
pip install climate-aware-task-scheduler
To install the development version:
bash
pip install git+https://github.com/GreenScheduler/cats
Documentation
Documentation is available at greenscheduler.github.io/cats/.
We recommend the quickstart if you are new to CATS. CATS can optionally display carbon footprint savings using a configuration file.
Console demonstration
CATS predicting optimal start time for the ls command in the OX1 postcode:
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
Owner
- Name: GreenScheduler
- Login: GreenScheduler
- Kind: organization
- Repositories: 1
- Profile: https://github.com/GreenScheduler
JOSS Publication
CATS: The Climate Aware Task Scheduler
Authors
National Centre for Atmospheric Science, United Kingdom, Department of Meteorology, University of Reading, United Kingdom
School of Psychology, University of Sussex, United Kingdom
Oxford Research Software Engineering Group, University of Oxford, United Kingdom
Bayesic Research, Ithaca, USA
British Heart Foundation Cardiovascular Epidemiology Unit, University of Cambridge, United Kingdom, Victor Phillip Dahdaleh Heart and Lung Research Institute, University of Cambridge, United Kingdom, Health Data Research UK Cambridge, United Kingdom
CNRM, Université de Toulouse, France
Netherlands eScience Center, Netherlands
National Oceanography Centre, United Kingdom
Department of Earth Sciences, University of Oxford, United Kingdom
National Oceanography Centre, United Kingdom
Editor
Jack Atkinson
GitHub Events
Total
- Create event: 9
- Release event: 1
- Issues event: 23
- Watch event: 21
- Delete event: 20
- Issue comment event: 56
- Push event: 59
- Pull request review comment event: 17
- Pull request review event: 24
- Pull request event: 31
- Fork event: 3
Last Year
- Create event: 9
- Release event: 1
- Issues event: 23
- Watch event: 21
- Delete event: 20
- Issue comment event: 56
- Push event: 59
- Pull request review comment event: 17
- Pull request review event: 24
- Pull request event: 31
- Fork event: 3
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Thibault Lestang | t****g@i****k | 108 |
| Abhishek Dasgupta | a****a@d****k | 73 |
| Sadie L. Bartholomew | s****w@n****k | 57 |
| Andrew Walker | a****r@e****k | 53 |
| 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 |
| Carlos Martinez | c****z@e****l | 2 |
| Nicolas Payette | n****e@g****m | 1 |
| Andy Turner | a****r@e****k | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 83
- Total pull requests: 114
- Average time to close issues: about 2 months
- Average time to close pull requests: 18 days
- Total issue authors: 11
- Total pull request authors: 11
- Average comments per issue: 1.29
- Average comments per pull request: 1.71
- Merged pull requests: 88
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 25
- Pull requests: 41
- Average time to close issues: 29 days
- Average time to close pull requests: 13 days
- Issue authors: 8
- Pull request authors: 6
- Average comments per issue: 0.48
- Average comments per pull request: 1.15
- Merged pull requests: 26
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- andreww (19)
- abhidg (19)
- sadielbartholomew (15)
- colinsauze (9)
- mkbane (6)
- Llannelongue (6)
- LiamPattinson (3)
- tlestang (2)
- elichad (1)
- ip2location (1)
- thomasferte (1)
Pull Request Authors
- andreww (35)
- abhidg (35)
- tlestang (17)
- sadielbartholomew (8)
- Llannelongue (6)
- colinsauze (2)
- nicolaspayette (2)
- aturner-epcc (2)
- danielskatz (2)
- c-martinez (1)
- ljcolling (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 41 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 3
- Total maintainers: 1
pypi.org: climate-aware-task-scheduler
Climate aware task scheduler
- Homepage: https://github.com/GreenScheduler/cats
- Documentation: https://climate-aware-task-scheduler.readthedocs.io/
- License: 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 8 months ago
Rankings
Maintainers (1)
Dependencies
- actions/checkout v3 composite
- actions/setup-python v4 composite
- PyYAML >=6.0
- requests-cache >=1.0