climate-ref-celery 0.5.0__tar.gz

climate_ref_celery-0.5.0/.gitignore

@@ -0,0 +1,161 @@
+# Notebooks
+*.ipynb
+
+# Databases
+*.db
+
+# Jupyter cache
+.jupyter_cache
+
+# IDE stuff
+.idea/
+
+# Ruff cache
+.ruff_cache
+
+# Licence check
+licence-check.txt
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# Mac stuff
+*.DS_Store
+
+# Esgpull
+.esgpull
+
+# Generated output
+out
+.ref
+
+# Ignore copied LICENCE/NOTICE files
+packages/*/LICENCE
+packages/*/NOTICE
+
+# Local directory for data
+/data

climate_ref_celery-0.5.0/LICENCE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

climate_ref_celery-0.5.0/NOTICE

@@ -0,0 +1,3 @@
+Assessment Fast Track Rapid Evaluation Framework
+
+Copyright 2024- CMIP7 Assessment Fast Track REF Technical Implementation Team

climate_ref_celery-0.5.0/PKG-INFO

@@ -0,0 +1,96 @@
+Metadata-Version: 2.4
+Name: climate-ref-celery
+Version: 0.5.0
+Summary: Celery app for mananging tasks and workers
+Author-email: Jared Lewis <jared.lewis@climate-resource.com>
+License-File: LICENCE
+License-File: NOTICE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.11
+Requires-Dist: celery[redis]>=5.4.0
+Requires-Dist: cmip-ref-core
+Requires-Dist: environs>=9
+Requires-Dist: loguru>=0.7.2
+Requires-Dist: tqdm>=4.67.1
+Requires-Dist: typer>=0.12.0
+Description-Content-Type: text/markdown
+
+# climate-ref-celery
+
+[![PyPI version](https://badge.fury.io/py/climate-ref-celery.svg)](https://badge.fury.io/py/climate-ref-celery)
+[![Documentation Status](https://readthedocs.org/projects/climate-ref/badge/?version=latest)](https://climate-ref.readthedocs.io/en/latest/?badge=latest)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Python Version](https://img.shields.io/badge/python-3.11%2B-blue)](https://www.python.org/downloads/)
+
+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
+
+```bash
+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:
+
+```bash
+# 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/](https://climate-ref.readthedocs.io/)
+
+## Contributing
+
+Contributions are welcome! Please see the main project's [Contributing Guide](https://climate-ref.readthedocs.io/en/latest/contributing/) for more information.
+
+## License
+
+This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.

climate_ref_celery-0.5.0/README.md

@@ -0,0 +1,70 @@
+# climate-ref-celery
+
+[![PyPI version](https://badge.fury.io/py/climate-ref-celery.svg)](https://badge.fury.io/py/climate-ref-celery)
+[![Documentation Status](https://readthedocs.org/projects/climate-ref/badge/?version=latest)](https://climate-ref.readthedocs.io/en/latest/?badge=latest)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Python Version](https://img.shields.io/badge/python-3.11%2B-blue)](https://www.python.org/downloads/)
+
+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
+
+```bash
+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:
+
+```bash
+# 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/](https://climate-ref.readthedocs.io/)
+
+## Contributing
+
+Contributions are welcome! Please see the main project's [Contributing Guide](https://climate-ref.readthedocs.io/en/latest/contributing/) for more information.
+
+## License
+
+This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.

climate_ref_celery-0.5.0/pyproject.toml

@@ -0,0 +1,46 @@
+[project]
+name = "climate-ref-celery"
+version = "0.5.0"
+description = "Celery app for mananging tasks and workers"
+readme = "README.md"
+authors = [
+    { name = "Jared Lewis", email = "jared.lewis@climate-resource.com" }
+]
+requires-python = ">=3.11"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Intended Audience :: Science/Research",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Scientific/Engineering",
+]
+dependencies = [
+    "cmip-ref-core",
+    "celery[redis]>=5.4.0",
+    "typer>=0.12.0",
+    "environs>=9",
+    "loguru>=0.7.2",
+    "tqdm>=4.67.1",
+]
+
+[project.scripts]
+ref-celery = "climate_ref_celery.cli:app"
+
+
+[tool.uv]
+dev-dependencies = [
+    "celery-types>=0.23.0",
+    "types-tqdm>=4.67.0.20250301",
+]
+
+[tool.uv.sources]
+ref-core = { workspace = true }
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"

climate_ref_celery-0.5.0/src/climate_ref_celery/__init__.py

@@ -0,0 +1,7 @@
+"""
+Rapid evaluating climate data
+"""
+
+import importlib.metadata
+
+__version__ = importlib.metadata.version("climate-ref-celery")

climate_ref_celery-0.5.0/src/climate_ref_celery/app.py

@@ -0,0 +1,57 @@
+"""
+Celery app creation
+"""
+
+import os
+from typing import Any
+
+from celery import Celery
+from celery.signals import setup_logging, worker_ready
+from loguru import logger
+from rich.pretty import pretty_repr
+
+from climate_ref.config import Config
+from climate_ref_core.logging import add_log_handler, capture_logging
+
+os.environ.setdefault("CELERY_CONFIG_MODULE", "climate_ref_celery.celeryconf.dev")
+
+
+def create_celery_app(name: str) -> Celery:
+    """
+    Create a Celery app
+
+    This function creates a new Celery app with the given name and configuration module.
+    The configuration module is loaded from the environment variable `CELERY_CONFIG_MODULE`
+    which defaults to `climate_ref_celery.celeryconf.dev` if not set.
+    """
+    app = Celery(name)
+    app.config_from_envvar("CELERY_CONFIG_MODULE")
+
+    return app
+
+
+@setup_logging.connect
+def setup_logging_handler(loglevel: int, **kwargs: Any) -> None:  # pragma: no cover
+    """Set up logging for the Celery worker using the celery signal"""
+    capture_logging()
+
+    # Include process name in celery logs
+    msg_format = (
+        "<green>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</green> | <level>{level: <8}</level> | {process.name} | "
+        "<cyan>{name}</cyan>:<cyan>{function}</cyan>:<cyan>{line}</cyan> - <level>{message}</level>"
+    )
+
+    logger.remove()
+    add_log_handler(level=loglevel, format=msg_format, colorize=True)
+
+
+@worker_ready.connect
+def worker_ready_handler(**kwargs: Any) -> None:  # pragma: no cover
+    """
+    Log a message when the worker is ready
+    """
+    config = Config.default()
+    logger.info(f"Worker ready with config {pretty_repr(config)}")
+
+
+app = create_celery_app("climate_ref_celery")

climate_ref_celery-0.5.0/src/climate_ref_celery/celeryconf/__init__.py

@@ -0,0 +1,7 @@
+"""
+Celery configuration.
+
+The modules in this package are used to configure Celery for different environments.
+The selected environment is determined by the `CELERY_CONFIG_MODULE` environment variable.
+The default environment is `climate_ref_celery.celeryconf.dev` which is used when running the app locally.
+"""

climate_ref_celery-0.5.0/src/climate_ref_celery/celeryconf/base.py

@@ -0,0 +1,18 @@
+"""
+Base configuration for Celery.
+
+Other environments can use these settings as a base and override them as needed.
+"""
+
+from climate_ref_core.env import get_env
+
+env = get_env()
+
+broker_url = env.str("CELERY_BROKER_URL", "redis://localhost:6379/1")
+result_backend = env.str("CELERY_RESULT_BACKEND", broker_url)
+broker_connection_retry_on_startup = True
+
+# Accept JSON and pickle as content
+accept_content = ["json", "pickle"]
+task_serializer = "pickle"
+result_serializer = "pickle"

climate_ref_celery-0.5.0/src/climate_ref_celery/celeryconf/dev.py

@@ -0,0 +1,8 @@
+"""Configuration for running celery locally"""
+
+from loguru import logger
+
+from .base import *  # noqa: F403
+
+# Currently the dev environment is the same as the base environment
+logger.info("Using dev configuration")