climate-ref-celery 0.5.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- climate_ref_celery/__init__.py +7 -0
- climate_ref_celery/app.py +57 -0
- climate_ref_celery/celeryconf/__init__.py +7 -0
- climate_ref_celery/celeryconf/base.py +18 -0
- climate_ref_celery/celeryconf/dev.py +8 -0
- climate_ref_celery/celeryconf/prod.py +8 -0
- climate_ref_celery/cli.py +102 -0
- climate_ref_celery/executor.py +133 -0
- climate_ref_celery/py.typed +0 -0
- climate_ref_celery/tasks.py +78 -0
- climate_ref_celery/worker_tasks.py +41 -0
- climate_ref_celery-0.5.0.dist-info/METADATA +96 -0
- climate_ref_celery-0.5.0.dist-info/RECORD +17 -0
- climate_ref_celery-0.5.0.dist-info/WHEEL +4 -0
- climate_ref_celery-0.5.0.dist-info/entry_points.txt +2 -0
- climate_ref_celery-0.5.0.dist-info/licenses/LICENCE +201 -0
- climate_ref_celery-0.5.0.dist-info/licenses/NOTICE +3 -0
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Celery app creation
|
|
3
|
+
"""
|
|
4
|
+
|
|
5
|
+
import os
|
|
6
|
+
from typing import Any
|
|
7
|
+
|
|
8
|
+
from celery import Celery
|
|
9
|
+
from celery.signals import setup_logging, worker_ready
|
|
10
|
+
from loguru import logger
|
|
11
|
+
from rich.pretty import pretty_repr
|
|
12
|
+
|
|
13
|
+
from climate_ref.config import Config
|
|
14
|
+
from climate_ref_core.logging import add_log_handler, capture_logging
|
|
15
|
+
|
|
16
|
+
os.environ.setdefault("CELERY_CONFIG_MODULE", "climate_ref_celery.celeryconf.dev")
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
def create_celery_app(name: str) -> Celery:
|
|
20
|
+
"""
|
|
21
|
+
Create a Celery app
|
|
22
|
+
|
|
23
|
+
This function creates a new Celery app with the given name and configuration module.
|
|
24
|
+
The configuration module is loaded from the environment variable `CELERY_CONFIG_MODULE`
|
|
25
|
+
which defaults to `climate_ref_celery.celeryconf.dev` if not set.
|
|
26
|
+
"""
|
|
27
|
+
app = Celery(name)
|
|
28
|
+
app.config_from_envvar("CELERY_CONFIG_MODULE")
|
|
29
|
+
|
|
30
|
+
return app
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
@setup_logging.connect
|
|
34
|
+
def setup_logging_handler(loglevel: int, **kwargs: Any) -> None: # pragma: no cover
|
|
35
|
+
"""Set up logging for the Celery worker using the celery signal"""
|
|
36
|
+
capture_logging()
|
|
37
|
+
|
|
38
|
+
# Include process name in celery logs
|
|
39
|
+
msg_format = (
|
|
40
|
+
"<green>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</green> | <level>{level: <8}</level> | {process.name} | "
|
|
41
|
+
"<cyan>{name}</cyan>:<cyan>{function}</cyan>:<cyan>{line}</cyan> - <level>{message}</level>"
|
|
42
|
+
)
|
|
43
|
+
|
|
44
|
+
logger.remove()
|
|
45
|
+
add_log_handler(level=loglevel, format=msg_format, colorize=True)
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
@worker_ready.connect
|
|
49
|
+
def worker_ready_handler(**kwargs: Any) -> None: # pragma: no cover
|
|
50
|
+
"""
|
|
51
|
+
Log a message when the worker is ready
|
|
52
|
+
"""
|
|
53
|
+
config = Config.default()
|
|
54
|
+
logger.info(f"Worker ready with config {pretty_repr(config)}")
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
app = create_celery_app("climate_ref_celery")
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Celery configuration.
|
|
3
|
+
|
|
4
|
+
The modules in this package are used to configure Celery for different environments.
|
|
5
|
+
The selected environment is determined by the `CELERY_CONFIG_MODULE` environment variable.
|
|
6
|
+
The default environment is `climate_ref_celery.celeryconf.dev` which is used when running the app locally.
|
|
7
|
+
"""
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Base configuration for Celery.
|
|
3
|
+
|
|
4
|
+
Other environments can use these settings as a base and override them as needed.
|
|
5
|
+
"""
|
|
6
|
+
|
|
7
|
+
from climate_ref_core.env import get_env
|
|
8
|
+
|
|
9
|
+
env = get_env()
|
|
10
|
+
|
|
11
|
+
broker_url = env.str("CELERY_BROKER_URL", "redis://localhost:6379/1")
|
|
12
|
+
result_backend = env.str("CELERY_RESULT_BACKEND", broker_url)
|
|
13
|
+
broker_connection_retry_on_startup = True
|
|
14
|
+
|
|
15
|
+
# Accept JSON and pickle as content
|
|
16
|
+
accept_content = ["json", "pickle"]
|
|
17
|
+
task_serializer = "pickle"
|
|
18
|
+
result_serializer = "pickle"
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Managing remote execution workers
|
|
3
|
+
"""
|
|
4
|
+
|
|
5
|
+
import importlib
|
|
6
|
+
|
|
7
|
+
import typer
|
|
8
|
+
|
|
9
|
+
from climate_ref_celery.app import create_celery_app
|
|
10
|
+
from climate_ref_celery.tasks import register_celery_tasks
|
|
11
|
+
from climate_ref_core.providers import DiagnosticProvider
|
|
12
|
+
|
|
13
|
+
app = typer.Typer(help=__doc__)
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
def import_provider(provider_package: str) -> DiagnosticProvider:
|
|
17
|
+
"""
|
|
18
|
+
Import the provider from a given package.
|
|
19
|
+
|
|
20
|
+
Parameters
|
|
21
|
+
----------
|
|
22
|
+
provider_package:
|
|
23
|
+
The package to import the provider from
|
|
24
|
+
|
|
25
|
+
Raises
|
|
26
|
+
------
|
|
27
|
+
typer.Abort
|
|
28
|
+
If the provider_package does not define a 'provider' variable
|
|
29
|
+
|
|
30
|
+
If the provider_package is not found
|
|
31
|
+
|
|
32
|
+
Returns
|
|
33
|
+
-------
|
|
34
|
+
:
|
|
35
|
+
The provider instance
|
|
36
|
+
"""
|
|
37
|
+
try:
|
|
38
|
+
imp = importlib.import_module(provider_package.replace("-", "_"))
|
|
39
|
+
except ModuleNotFoundError:
|
|
40
|
+
typer.echo(f"Package '{provider_package}' not found")
|
|
41
|
+
raise typer.Abort()
|
|
42
|
+
|
|
43
|
+
# Get the provider from the provider_package
|
|
44
|
+
try:
|
|
45
|
+
provider = imp.provider
|
|
46
|
+
except AttributeError:
|
|
47
|
+
typer.echo("The package must define a 'provider' attribute")
|
|
48
|
+
raise typer.Abort()
|
|
49
|
+
if not isinstance(provider, DiagnosticProvider):
|
|
50
|
+
typer.echo(f"Expected DiagnosticProvider, got {type(provider)}")
|
|
51
|
+
raise typer.Abort()
|
|
52
|
+
return provider
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
@app.command()
|
|
56
|
+
def start_worker(
|
|
57
|
+
loglevel: str = typer.Option("info", help="Log level for the worker"),
|
|
58
|
+
package: str | None = typer.Option(help="Package to import tasks from", default=None),
|
|
59
|
+
extra_args: list[str] = typer.Argument(None, help="Additional arguments for the worker"),
|
|
60
|
+
) -> None:
|
|
61
|
+
"""
|
|
62
|
+
Start a Celery worker for the given package.
|
|
63
|
+
|
|
64
|
+
A celery worker enables the execution of tasks in the background on multiple different nodes.
|
|
65
|
+
This worker will register a celery task for each diagnostic in the provider.
|
|
66
|
+
The worker tasks can be executed by sending a celery task with the name
|
|
67
|
+
'{package_slug}_{diagnostic_slug}'.
|
|
68
|
+
|
|
69
|
+
The package must define a 'provider' variable that is an instance of 'ref_core.DiagnosticProvider'.
|
|
70
|
+
"""
|
|
71
|
+
# Create a new celery app
|
|
72
|
+
celery_app = create_celery_app("climate_ref_celery")
|
|
73
|
+
|
|
74
|
+
if package:
|
|
75
|
+
# Attempt to import the provider
|
|
76
|
+
provider = import_provider(package)
|
|
77
|
+
|
|
78
|
+
# Wrap each diagnostics in the provider with a celery tasks
|
|
79
|
+
register_celery_tasks(celery_app, provider)
|
|
80
|
+
queue = provider.slug
|
|
81
|
+
else:
|
|
82
|
+
# This might need some tweaking in later PRs to pull in the appropriate tasks
|
|
83
|
+
import climate_ref_celery.worker_tasks # noqa: F401
|
|
84
|
+
|
|
85
|
+
queue = "celery"
|
|
86
|
+
|
|
87
|
+
argv = ["worker", f"--loglevel={loglevel}", f"--queues={queue}", *(extra_args or [])]
|
|
88
|
+
celery_app.worker_main(argv=argv)
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
@app.command()
|
|
92
|
+
def list_config() -> None:
|
|
93
|
+
"""
|
|
94
|
+
List the celery configuration
|
|
95
|
+
"""
|
|
96
|
+
celery_app = create_celery_app("climate_ref_celery")
|
|
97
|
+
|
|
98
|
+
print(celery_app.conf.humanize())
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
if __name__ == "__main__": # pragma: no cover
|
|
102
|
+
app()
|
|
@@ -0,0 +1,133 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Executor for running diagnostics asynchronously using Celery
|
|
3
|
+
"""
|
|
4
|
+
|
|
5
|
+
import time
|
|
6
|
+
from typing import Any
|
|
7
|
+
|
|
8
|
+
import celery.exceptions
|
|
9
|
+
import celery.result
|
|
10
|
+
from loguru import logger
|
|
11
|
+
from tqdm import tqdm
|
|
12
|
+
|
|
13
|
+
from climate_ref.config import Config
|
|
14
|
+
from climate_ref.models import Execution
|
|
15
|
+
from climate_ref_celery.app import app
|
|
16
|
+
from climate_ref_celery.tasks import generate_task_name
|
|
17
|
+
from climate_ref_core.diagnostics import Diagnostic, ExecutionDefinition, ExecutionResult
|
|
18
|
+
from climate_ref_core.executor import Executor
|
|
19
|
+
from climate_ref_core.providers import DiagnosticProvider
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
class CeleryExecutor(Executor):
|
|
23
|
+
"""
|
|
24
|
+
Run a diagnostic asynchronously
|
|
25
|
+
|
|
26
|
+
Celery is an asynchronous task queue/job queue based on distributed message passing.
|
|
27
|
+
Celery uses a message broker to distribute tasks across a cluster of worker nodes.
|
|
28
|
+
The worker nodes are responsible for executing the tasks.
|
|
29
|
+
The message broker used in this case is [Redis](https://github.com/redis/redis).
|
|
30
|
+
The worker node may be running on the same machine as the client or on a different machine,
|
|
31
|
+
either natively or via a docker container.
|
|
32
|
+
|
|
33
|
+
We cannot resume tasks that are in progress if the process terminates.
|
|
34
|
+
That should be possible tracking some additional state in the database.
|
|
35
|
+
"""
|
|
36
|
+
|
|
37
|
+
name = "celery"
|
|
38
|
+
|
|
39
|
+
def __init__(self, *, config: Config, **kwargs: Any) -> None:
|
|
40
|
+
self.config = config
|
|
41
|
+
super().__init__(**kwargs) # type: ignore
|
|
42
|
+
self._results: list[celery.result.AsyncResult[ExecutionResult]] = []
|
|
43
|
+
|
|
44
|
+
def run(
|
|
45
|
+
self,
|
|
46
|
+
provider: DiagnosticProvider,
|
|
47
|
+
diagnostic: Diagnostic,
|
|
48
|
+
definition: ExecutionDefinition,
|
|
49
|
+
execution: Execution | None = None,
|
|
50
|
+
) -> None:
|
|
51
|
+
"""
|
|
52
|
+
Run a diagnostic calculation
|
|
53
|
+
|
|
54
|
+
This will queue the diagnostic to be run by a Celery worker.
|
|
55
|
+
The executions will be stored in the database when the task completes if `execution`
|
|
56
|
+
is specified.
|
|
57
|
+
No result will be returned from this function.
|
|
58
|
+
Instead, you can periodically check the status of the task in the database.
|
|
59
|
+
|
|
60
|
+
Tasks may not execute immediately if the correct workers are not available.
|
|
61
|
+
The task will be queued and executed when a worker becomes available.
|
|
62
|
+
|
|
63
|
+
Parameters
|
|
64
|
+
----------
|
|
65
|
+
provider
|
|
66
|
+
Provider for the diagnostic
|
|
67
|
+
diagnostic
|
|
68
|
+
Diagnostic to run
|
|
69
|
+
definition
|
|
70
|
+
A description of the information needed for this execution of the diagnostic
|
|
71
|
+
This includes relative paths to the data files,
|
|
72
|
+
which will be converted to absolute paths when being executed
|
|
73
|
+
execution
|
|
74
|
+
Result of the diagnostic execution
|
|
75
|
+
This is a database object that contains the executions of the execution.
|
|
76
|
+
If provided, it will be updated with the executions of the execution.
|
|
77
|
+
This may happen asynchronously, so the executions may not be immediately available.
|
|
78
|
+
"""
|
|
79
|
+
from climate_ref_celery.worker_tasks import handle_result
|
|
80
|
+
|
|
81
|
+
name = generate_task_name(provider, diagnostic)
|
|
82
|
+
|
|
83
|
+
async_result = app.send_task(
|
|
84
|
+
name,
|
|
85
|
+
args=[definition, self.config.log_level],
|
|
86
|
+
queue=provider.slug,
|
|
87
|
+
link=handle_result.s(execution_id=execution.id).set(queue="celery") if execution else None,
|
|
88
|
+
)
|
|
89
|
+
logger.debug(f"Celery task {async_result.id} submitted")
|
|
90
|
+
self._results.append(async_result)
|
|
91
|
+
|
|
92
|
+
def join(self, timeout: float) -> None:
|
|
93
|
+
"""
|
|
94
|
+
Wait for all executions to finish
|
|
95
|
+
|
|
96
|
+
This will block until all executions have finished running,
|
|
97
|
+
and display a progress bar while waiting.
|
|
98
|
+
|
|
99
|
+
Any tasks still running after the timeout will continue to run in the background.
|
|
100
|
+
|
|
101
|
+
Parameters
|
|
102
|
+
----------
|
|
103
|
+
timeout
|
|
104
|
+
Maximum time to wait in seconds before raising a TimeoutError
|
|
105
|
+
|
|
106
|
+
Raises
|
|
107
|
+
------
|
|
108
|
+
TimeoutError
|
|
109
|
+
If all executions aren't completed within the specified timeout
|
|
110
|
+
"""
|
|
111
|
+
start_time = time.time()
|
|
112
|
+
refresh_time = 0.5 # Time to wait between checking for completed tasks in seconds
|
|
113
|
+
|
|
114
|
+
results = self._results
|
|
115
|
+
t = tqdm(total=len(results), desc="Waiting for executions to complete", unit="execution")
|
|
116
|
+
|
|
117
|
+
try:
|
|
118
|
+
while results:
|
|
119
|
+
# Wait for a short time before checking for completed executions
|
|
120
|
+
time.sleep(refresh_time)
|
|
121
|
+
|
|
122
|
+
elapsed_time = time.time() - start_time
|
|
123
|
+
|
|
124
|
+
if elapsed_time > timeout:
|
|
125
|
+
raise TimeoutError("Not all tasks completed within the specified timeout")
|
|
126
|
+
|
|
127
|
+
# Iterate over a copy of the list and remove finished tasks
|
|
128
|
+
for result in results[:]:
|
|
129
|
+
if result.ready():
|
|
130
|
+
t.update(n=1)
|
|
131
|
+
results.remove(result)
|
|
132
|
+
finally:
|
|
133
|
+
t.close()
|
|
File without changes
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Task generation and registration for Celery
|
|
3
|
+
|
|
4
|
+
This module provides a factory function to create Celery tasks for diagnostics.
|
|
5
|
+
These celery tasks are then registered with the Celery app to enable them to be run asynchronously.
|
|
6
|
+
|
|
7
|
+
Since the diagnostic definition may be in a different virtual environment it is not possible to directly
|
|
8
|
+
import the provider and create the tasks in both the worker and the main process.
|
|
9
|
+
|
|
10
|
+
Instead, the tasks are registered only in the worker process.
|
|
11
|
+
The main process can then send tasks to the worker using the task name.
|
|
12
|
+
The main process is responsible for tracking what diagnostics have been registered
|
|
13
|
+
and to respond to new workers coming online.
|
|
14
|
+
"""
|
|
15
|
+
|
|
16
|
+
from collections.abc import Callable
|
|
17
|
+
|
|
18
|
+
from celery import Celery
|
|
19
|
+
from loguru import logger
|
|
20
|
+
|
|
21
|
+
from climate_ref_core.diagnostics import Diagnostic, ExecutionDefinition, ExecutionResult
|
|
22
|
+
from climate_ref_core.logging import redirect_logs
|
|
23
|
+
from climate_ref_core.providers import DiagnosticProvider
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
def generate_task_name(provider: DiagnosticProvider, diagnostic: Diagnostic) -> str:
|
|
27
|
+
"""
|
|
28
|
+
Generate the name of the task for the given provider and diagnostic
|
|
29
|
+
"""
|
|
30
|
+
return f"{provider.slug}.{diagnostic.slug}"
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
def _diagnostic_task_factory(
|
|
34
|
+
diagnostic: Diagnostic,
|
|
35
|
+
) -> Callable[
|
|
36
|
+
[ExecutionDefinition, str],
|
|
37
|
+
ExecutionResult,
|
|
38
|
+
]:
|
|
39
|
+
"""
|
|
40
|
+
Create a new task for the given diagnostic
|
|
41
|
+
"""
|
|
42
|
+
|
|
43
|
+
def task(definition: ExecutionDefinition, log_level: str) -> ExecutionResult:
|
|
44
|
+
"""
|
|
45
|
+
Task to run the diagnostic
|
|
46
|
+
"""
|
|
47
|
+
logger.info(f"Running diagnostic {diagnostic.name} with definition {definition}")
|
|
48
|
+
try:
|
|
49
|
+
with redirect_logs(definition, log_level):
|
|
50
|
+
return diagnostic.run(definition)
|
|
51
|
+
except Exception:
|
|
52
|
+
logger.exception(f"Error running diagnostic {diagnostic.slug}:{definition.key}")
|
|
53
|
+
# TODO: This exception should be caught and a unsuccessful result returned.
|
|
54
|
+
raise
|
|
55
|
+
|
|
56
|
+
return task
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
def register_celery_tasks(app: Celery, provider: DiagnosticProvider) -> None:
|
|
60
|
+
"""
|
|
61
|
+
Register all tasks for the given provider
|
|
62
|
+
|
|
63
|
+
This is run on worker startup to register all tasks a given provider
|
|
64
|
+
|
|
65
|
+
Parameters
|
|
66
|
+
----------
|
|
67
|
+
app
|
|
68
|
+
The Celery app to register the tasks with
|
|
69
|
+
provider
|
|
70
|
+
The provider to register tasks for
|
|
71
|
+
"""
|
|
72
|
+
for metric in provider.diagnostics():
|
|
73
|
+
print(f"Registering task for diagnostic {metric.name}")
|
|
74
|
+
app.task( # type: ignore
|
|
75
|
+
_diagnostic_task_factory(metric),
|
|
76
|
+
name=generate_task_name(provider, metric),
|
|
77
|
+
queue=provider.slug,
|
|
78
|
+
)
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Celery worker tasks for handling diagnostic execution executions.
|
|
3
|
+
"""
|
|
4
|
+
|
|
5
|
+
from celery import current_app
|
|
6
|
+
from loguru import logger
|
|
7
|
+
|
|
8
|
+
from climate_ref.config import Config
|
|
9
|
+
from climate_ref.database import Database
|
|
10
|
+
from climate_ref.executor import handle_execution_result
|
|
11
|
+
from climate_ref.models import Execution
|
|
12
|
+
from climate_ref_core.diagnostics import ExecutionResult
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
@current_app.task
|
|
16
|
+
def handle_result(result: ExecutionResult, execution_id: int) -> None:
|
|
17
|
+
"""
|
|
18
|
+
Handle the result of a diagnostic execution
|
|
19
|
+
|
|
20
|
+
This function is called when a diagnostic execution is completed.
|
|
21
|
+
|
|
22
|
+
Parameters
|
|
23
|
+
----------
|
|
24
|
+
execution_id
|
|
25
|
+
The unique identifier for the diagnostic execution
|
|
26
|
+
result
|
|
27
|
+
The result of the diagnostic execution
|
|
28
|
+
"""
|
|
29
|
+
logger.info(f"Handling result for execution {execution_id} + {result}")
|
|
30
|
+
|
|
31
|
+
config = Config.default()
|
|
32
|
+
db = Database.from_config(config, run_migrations=False)
|
|
33
|
+
|
|
34
|
+
with db.session.begin():
|
|
35
|
+
execution = db.session.get(Execution, execution_id)
|
|
36
|
+
|
|
37
|
+
if execution is None:
|
|
38
|
+
logger.error(f"Execution {execution_id} not found")
|
|
39
|
+
return
|
|
40
|
+
|
|
41
|
+
handle_execution_result(config, db, execution, result)
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: climate-ref-celery
|
|
3
|
+
Version: 0.5.0
|
|
4
|
+
Summary: Celery app for mananging tasks and workers
|
|
5
|
+
Author-email: Jared Lewis <jared.lewis@climate-resource.com>
|
|
6
|
+
License-File: LICENCE
|
|
7
|
+
License-File: NOTICE
|
|
8
|
+
Classifier: Development Status :: 4 - Beta
|
|
9
|
+
Classifier: Intended Audience :: Developers
|
|
10
|
+
Classifier: Intended Audience :: Science/Research
|
|
11
|
+
Classifier: Operating System :: OS Independent
|
|
12
|
+
Classifier: Programming Language :: Python
|
|
13
|
+
Classifier: Programming Language :: Python :: 3
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
17
|
+
Classifier: Topic :: Scientific/Engineering
|
|
18
|
+
Requires-Python: >=3.11
|
|
19
|
+
Requires-Dist: celery[redis]>=5.4.0
|
|
20
|
+
Requires-Dist: cmip-ref-core
|
|
21
|
+
Requires-Dist: environs>=9
|
|
22
|
+
Requires-Dist: loguru>=0.7.2
|
|
23
|
+
Requires-Dist: tqdm>=4.67.1
|
|
24
|
+
Requires-Dist: typer>=0.12.0
|
|
25
|
+
Description-Content-Type: text/markdown
|
|
26
|
+
|
|
27
|
+
# climate-ref-celery
|
|
28
|
+
|
|
29
|
+
[](https://badge.fury.io/py/climate-ref-celery)
|
|
30
|
+
[](https://climate-ref.readthedocs.io/en/latest/?badge=latest)
|
|
31
|
+
[](https://opensource.org/licenses/Apache-2.0)
|
|
32
|
+
[](https://www.python.org/downloads/)
|
|
33
|
+
|
|
34
|
+
This package provides Celery task generation and worker management for the Climate REF (Rapid Evaluation Framework).
|
|
35
|
+
|
|
36
|
+
The `climate_ref_celery` package provides a CLI tool(`ref-celery`) to start a worker instance for a diagnostics provider.
|
|
37
|
+
This worker instance will listen for tasks related to a provider and execute them.
|
|
38
|
+
The compute engine worker will then collect the results of these tasks and store them in the database.
|
|
39
|
+
This allows for the REF to be run in a distributed manner,
|
|
40
|
+
with multiple workers running on different machines with a centrally managed database.
|
|
41
|
+
|
|
42
|
+
## Installation
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
pip install climate-ref-celery
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## Features
|
|
49
|
+
|
|
50
|
+
- Distributed task execution for metrics providers
|
|
51
|
+
- Worker management and monitoring
|
|
52
|
+
- Automatic task routing and scheduling
|
|
53
|
+
- Results collection and storage
|
|
54
|
+
- Support for multiple worker instances
|
|
55
|
+
|
|
56
|
+
## Usage
|
|
57
|
+
|
|
58
|
+
### Starting a Worker
|
|
59
|
+
|
|
60
|
+
To start a worker instance for a specific metrics provider:
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
# Using the standalone CLI
|
|
64
|
+
ref-celery start-worker --package climate_ref_pmp
|
|
65
|
+
|
|
66
|
+
# Or using the main REF CLI
|
|
67
|
+
ref celery start-worker --package climate_ref_pmp
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### Configuration
|
|
71
|
+
|
|
72
|
+
Each worker instance may not share the same configuration as the orchestrator.
|
|
73
|
+
This is because the worker may be running on a different machine with different resources available or
|
|
74
|
+
directories.
|
|
75
|
+
|
|
76
|
+
Each worker instance requires access to a shared input data directory and the output directory.
|
|
77
|
+
If the worker is deployed as a docker container these directories can be mounted as volumes.
|
|
78
|
+
|
|
79
|
+
Each worker instance can be configured independently. Required configurations include:
|
|
80
|
+
|
|
81
|
+
- Shared input data directory
|
|
82
|
+
- Output directory for results
|
|
83
|
+
- Database connection settings
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
## Documentation
|
|
87
|
+
|
|
88
|
+
For detailed documentation, please visit [https://climate-ref.readthedocs.io/](https://climate-ref.readthedocs.io/)
|
|
89
|
+
|
|
90
|
+
## Contributing
|
|
91
|
+
|
|
92
|
+
Contributions are welcome! Please see the main project's [Contributing Guide](https://climate-ref.readthedocs.io/en/latest/contributing/) for more information.
|
|
93
|
+
|
|
94
|
+
## License
|
|
95
|
+
|
|
96
|
+
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
climate_ref_celery/__init__.py,sha256=f-dS4JxMLmTCobZtftGDi6bUbtYCv_9iWqxSpC74tWw,129
|
|
2
|
+
climate_ref_celery/app.py,sha256=wLzAnrpzkwZLYY6HY_riHUEtjiRQpkKDSeKZpyMTxAQ,1694
|
|
3
|
+
climate_ref_celery/cli.py,sha256=-bkyEc8pJ5hV2tat7gRzGHoCGWP9qQrJIJ1KvZ3941k,2992
|
|
4
|
+
climate_ref_celery/executor.py,sha256=RtpbelMoxI2i-Wu7NYrBzQIp07gJce2yPLUsM16w7kc,4944
|
|
5
|
+
climate_ref_celery/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
6
|
+
climate_ref_celery/tasks.py,sha256=vA7gvESuXMp3BT9Bz6ULNypDSRUUkvAHHRjumf3I3sU,2629
|
|
7
|
+
climate_ref_celery/worker_tasks.py,sha256=slUprhM8G14D3r6RACSh2alzj-_JWXU4JKG5GR0GLpA,1194
|
|
8
|
+
climate_ref_celery/celeryconf/__init__.py,sha256=xKcHhnECGZAxrjnMtfaPBU_vgqwRbRLXFw8WVQ7WxaE,314
|
|
9
|
+
climate_ref_celery/celeryconf/base.py,sha256=uXaz9S_1hCdwKpvyWBDWE69YVIXHD3Ar7egNKLk9Gx8,484
|
|
10
|
+
climate_ref_celery/celeryconf/dev.py,sha256=um7hvEhlTBfwey9ler_vAHAln_DrpqAP3fbbO2wdmUQ,217
|
|
11
|
+
climate_ref_celery/celeryconf/prod.py,sha256=HyGTfwTZD8MjIkfkb3qyfzjjTPE9sKAoXNq3fJDFO9Q,231
|
|
12
|
+
climate_ref_celery-0.5.0.dist-info/METADATA,sha256=zkB5LN8wUrSswFvN7knOH4mcUJ50bpHouaETWUshoi0,3567
|
|
13
|
+
climate_ref_celery-0.5.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
|
|
14
|
+
climate_ref_celery-0.5.0.dist-info/entry_points.txt,sha256=U9b-T6EpLV3ZXmHUpEzp8x5TZnCjQ1ynncIkFMwDuPE,58
|
|
15
|
+
climate_ref_celery-0.5.0.dist-info/licenses/LICENCE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
|
|
16
|
+
climate_ref_celery-0.5.0.dist-info/licenses/NOTICE,sha256=4qTlax9aX2-mswYJuVrLqJ9jK1IkN5kSBqfVvYLF3Ws,128
|
|
17
|
+
climate_ref_celery-0.5.0.dist-info/RECORD,,
|
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|