climate-ref-celery
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.
2 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file climate_ref_celery-0.18.1.tar.gz.
File metadata
- Download URL: climate_ref_celery-0.18.1.tar.gz
- Upload date:
- Size: 24.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.12.7 {"installer":{"name":"uv","version":"0.12.7","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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9bed7e6da94d96c20601571b275c9cd7ed7a59da933b270acfda8e230f94685d
|
|
| MD5 |
c5cea4d45a6183de642989c6c69b9b20
|
|
| BLAKE2b-256 |
42b8890055d0bc4fb21c7c5e8bf8957a64f447cf9c707c54869ed01e3f7c6330
|
File details
Details for the file climate_ref_celery-0.18.1-py3-none-any.whl.
File metadata
- Download URL: climate_ref_celery-0.18.1-py3-none-any.whl
- Upload date:
- Size: 23.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.12.7 {"installer":{"name":"uv","version":"0.12.7","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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f005ad5a474870d37d18912f6627bea7c303a793bfef607646d30a7b6828251d
|
|
| MD5 |
60da82a9a7860b49f56c48919a0eef17
|
|
| BLAKE2b-256 |
002684c7ee66785e84d200882c4345393bdc6a1020a9d1e8c32f8c10268b066b
|
