Skip to main content

Climate aware task scheduler

Project description

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.

CATS

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:

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:

CATS animated usage example

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

climate_aware_task_scheduler-1.0.0.tar.gz (21.2 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file climate_aware_task_scheduler-1.0.0.tar.gz.

File metadata

File hashes

Hashes for climate_aware_task_scheduler-1.0.0.tar.gz
Algorithm Hash digest
SHA256 ea8525823f74db14c99e64406ea192a7e1ebcc4c0bf66b50291d104d9bd2f490
MD5 f56f77d722f199830be98ae4ad673608
BLAKE2b-256 0624e94f6d5d886680d140a729bd8d9f2db9c80089ec99f55cfba938bf57cc58

See more details on using hashes here.

File details

Details for the file climate_aware_task_scheduler-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for climate_aware_task_scheduler-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5b31e30440db747bfb16048fdedd9d4b81489120ba78f2eb3f4473cb281be147
MD5 f409beef94ae7a76095a04afae3fe25f
BLAKE2b-256 b55e4e1e850ac19957c4b71dbf5714b65f0eb3c703a6a9d49529234fa1baec48

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page