Skip to main content

climate-ref-celery

PyPI version Documentation Status License Python Version

This package provides Celery task generation and worker management for the Climate REF (Rapid Evaluation Framework).

The climate_ref_celery package provides a CLI tool(ref-celery) to start a worker instance for a diagnostics provider. This worker instance will listen for tasks related to a provider and execute them. The compute engine worker will then collect the results of these tasks and store them in the database. This allows for the REF to be run in a distributed manner, with multiple workers running on different machines with a centrally managed database.

Installation

pip install climate-ref-celery

Features

  • Distributed task execution for metrics providers
  • Worker management and monitoring
  • Automatic task routing and scheduling
  • Results collection and storage
  • Support for multiple worker instances

Usage

Starting a Worker

To start a worker instance for a specific metrics provider:

# Using the standalone CLI
ref-celery start-worker --package climate_ref_pmp

# Or using the main REF CLI
ref celery start-worker --package climate_ref_pmp

Configuration

Each worker instance may not share the same configuration as the orchestrator. This is because the worker may be running on a different machine with different resources available or directories.

Each worker instance requires access to a shared input data directory and the output directory. If the worker is deployed as a docker container these directories can be mounted as volumes.

Each worker instance can be configured independently. Required configurations include:

  • Shared input data directory
  • Output directory for results
  • Database connection settings

Documentation

For detailed documentation, please visit https://climate-ref.readthedocs.io/

Contributing

Contributions are welcome! Please see the main project's Contributing Guide for more information.

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for 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_ref_celery-0.17.2.tar.gz (24.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

climate_ref_celery-0.17.2-py3-none-any.whl (23.2 kB view details)

Uploaded Python 3

File details

Details for the file climate_ref_celery-0.17.2.tar.gz.

File metadata

  • Download URL: climate_ref_celery-0.17.2.tar.gz
  • Upload date:
  • Size: 24.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.6 {"installer":{"name":"uv","version":"0.11.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for climate_ref_celery-0.17.2.tar.gz
Algorithm Hash digest
SHA256 c0a2a11c10637838a0ff87ef62df612d7e8a4efc0276c0a98453d696b9905eee
MD5 d7500ae9d7a6a8c5e432ade58a3e36eb
BLAKE2b-256 5a6ca7df76967f2dc944a58ada340f9eccbc5821ee4a84fd14d874eecbf0062c

See more details on using hashes here.

File details

Details for the file climate_ref_celery-0.17.2-py3-none-any.whl.

File metadata

  • Download URL: climate_ref_celery-0.17.2-py3-none-any.whl
  • Upload date:
  • Size: 23.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.6 {"installer":{"name":"uv","version":"0.11.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for climate_ref_celery-0.17.2-py3-none-any.whl
Algorithm Hash digest
SHA256 61ff01a42808c8761f7e1df3aae555a29de1f0c7eb6764a4e07a39cfbec4c191
MD5 8b5b61bbe9a80a66dac6ed81066ca0d2
BLAKE2b-256 671c606f3684126fe87728e23d40c53e5cb7ba681a9a495c1270331856420a9d

See more details on using hashes here.

Release history Release notifications | RSS feed

0.18.1

2 files

0.18.0

2 files

This release

0.17.2 This release

2 files

0.17.1

2 files

0.17.0

2 files

0.16.2

2 files

0.16.1

2 files

0.16.0

2 files

0.15.0

2 files

0.14.7

2 files

0.14.6

2 files

0.14.5

2 files

0.14.4

2 files

0.14.3

2 files

0.14.2

2 files

0.14.1

2 files

0.14.0

2 files

0.13.2

2 files

0.13.1

2 files

0.13.0

2 files

0.12.3

2 files

0.12.2

2 files

0.12.0

2 files

0.11.1

2 files

0.11.0

2 files

0.10.0

2 files

0.9.1

2 files

0.9.0

2 files

0.8.1

2 files

0.8.0

2 files

0.7.0

2 files

0.6.6

2 files

0.6.5

2 files

0.6.4

2 files

0.6.3

2 files

0.6.2

2 files

0.6.1

2 files

0.6.0

2 files

0.5.5

2 files

0.5.4

2 files

0.5.3

2 files

0.5.2

2 files

0.5.1

2 files

0.5.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page