climate-ref 0.5.1__tar.gz → 0.5.2__tar.gz

{climate_ref-0.5.1 → climate_ref-0.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: climate-ref
-Version: 0.5.1
+Version: 0.5.2
 Summary: Application which runs the CMIP Rapid Evaluation Framework
 Author-email: Jared Lewis <jared.lewis@climate-resource.com>, Mika Pflueger <mika.pflueger@climate-resource.com>, Bouwe Andela <b.andela@esciencecenter.nl>, Jiwoo Lee <lee1043@llnl.gov>, Min Xu <xum1@ornl.gov>, Nathan Collier <collierno@ornl.gov>, Dora Hegedus <dora.hegedus@stfc.ac.uk>
 License: Apache-2.0
@@ -30,15 +30,19 @@ Requires-Dist: sqlalchemy>=2.0.36
 Requires-Dist: tomlkit>=0.13.2
 Requires-Dist: tqdm>=4.67.1
 Requires-Dist: typer>=0.12.5
+Provides-Extra: aft-providers
+Requires-Dist: climate-ref-esmvaltool>=0.5.0; extra == 'aft-providers'
+Requires-Dist: climate-ref-ilamb>=0.5.0; extra == 'aft-providers'
+Requires-Dist: climate-ref-pmp>=0.5.0; extra == 'aft-providers'
 Provides-Extra: celery
 Requires-Dist: climate-ref-celery>=0.5.0; extra == 'celery'
-Provides-Extra: metrics
-Requires-Dist: climate-ref-esmvaltool>=0.5.0; extra == 'metrics'
-Requires-Dist: climate-ref-ilamb>=0.5.0; extra == 'metrics'
-Requires-Dist: climate-ref-pmp>=0.5.0; extra == 'metrics'
 Provides-Extra: postgres
 Requires-Dist: alembic-postgresql-enum>=1.7.0; extra == 'postgres'
 Requires-Dist: psycopg2-binary>=2.9.2; extra == 'postgres'
+Provides-Extra: providers
+Requires-Dist: climate-ref-esmvaltool>=0.5.0; extra == 'providers'
+Requires-Dist: climate-ref-ilamb>=0.5.0; extra == 'providers'
+Requires-Dist: climate-ref-pmp>=0.5.0; extra == 'providers'
 Description-Content-Type: text/markdown
 
 # Climate REF (Rapid Evaluation Framework)
@@ -64,7 +68,7 @@ pip install climate-ref
 If you want to use the diagnostic providers for the Assessment Fast Track, you can install them with:
 
 ```bash
-pip install climate-ref[metrics]
+pip install climate-ref[aft-providers]
 ```
 
 ## Quick Start

{climate_ref-0.5.1 → climate_ref-0.5.2}/README.md

@@ -21,7 +21,7 @@ pip install climate-ref
 If you want to use the diagnostic providers for the Assessment Fast Track, you can install them with:
 
 ```bash
-pip install climate-ref[metrics]
+pip install climate-ref[aft-providers]
 ```
 
 ## Quick Start

{climate_ref-0.5.1 → climate_ref-0.5.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "climate-ref"
-version = "0.5.1"
+version = "0.5.2"
 description = "Application which runs the CMIP Rapid Evaluation Framework"
 readme = "README.md"
 authors = [
@@ -49,7 +49,12 @@ postgres = [
 celery = [
     "climate-ref-celery>=0.5.0",
 ]
-metrics = [
+aft-providers = [
+    "climate-ref-esmvaltool>=0.5.0",
+    "climate-ref-pmp>=0.5.0",
+    "climate-ref-ilamb>=0.5.0",
+]
+providers = [
     "climate-ref-esmvaltool>=0.5.0",
     "climate-ref-pmp>=0.5.0",
     "climate-ref-ilamb>=0.5.0",

{climate_ref-0.5.1 → climate_ref-0.5.2}/src/climate_ref/config.py

@@ -74,11 +74,13 @@ class PathConfig:
     /// admonition | Warning
         type: warning
 
-    These paths must be common across all systems that the REF is being run
+    These paths must be common across all systems that the REF is being run.
+    Generally, this means that they should be mounted in the same location on all systems.
     ///
 
     If any of these paths are specified as relative paths,
     they will be resolved to absolute paths.
+    These absolute paths will be used for all operations in the REF.
     """
 
     log: Path = env_field(name="LOG_ROOT", converter=ensure_absolute_path)
@@ -157,12 +159,12 @@ class ExecutorConfig:
 
     executor: str = env_field(name="EXECUTOR", default="climate_ref.executor.LocalExecutor")
     """
-    Executor to use for running diagnostics
+    Executor class to use for running diagnostics
 
     This should be the fully qualified name of the executor class
     (e.g. `climate_ref.executor.LocalExecutor`).
-    The default is to use the local executor.
-    The environment variable `REF_EXECUTOR` takes precedence over this configuration value.
+    The default is to use the local executor which runs the executions locally, in-parallel
+    using a process pool.
 
     This class will be used for all executions of diagnostics.
     """
@@ -172,6 +174,7 @@ class ExecutorConfig:
     Additional configuration for the executor.
 
     See the documentation for the executor for the available configuration options.
+    These options will be passed to the executor class when it is created.
     """
 
     def build(self, config: "Config", database: "Database") -> Executor:
@@ -199,7 +202,30 @@ class ExecutorConfig:
 @define
 class DiagnosticProviderConfig:
     """
-    Configuration for the diagnostic providers
+    Defining the diagnostic providers used by the REF.
+
+    Each diagnostic provider is a package that contains the logic for running a specific
+    set of diagnostics.
+    This configuration determines which diagnostic providers are loaded and used when solving.
+
+    Multiple diagnostic providers can be specified as shown in the example below.
+
+    ```toml
+    [[diagnostic_providers]]
+    provider = "climate_ref_esmvaltool.provider"
+
+    [diagnostic_providers.config]
+
+    [[diagnostic_providers]]
+    provider = "climate_ref_ilamb.provider"
+
+    [diagnostic_providers.config]
+
+    [[diagnostic_providers]]
+    provider = "climate_ref_pmp.provider"
+
+    [diagnostic_providers.config]
+    ```
     """
 
     provider: str
@@ -224,21 +250,29 @@ class DbConfig:
     """
     Database configuration
 
-    We currently only plan to support SQLite and PostgreSQL databases,
-    although only SQLite is currently implemented and tested.
+    We support SQLite and PostgreSQL databases.
+    The default is to use SQLite, which is a file-based database that is stored in the
+    `REF_CONFIGURATION` directory.
+    This is a good option for testing and development, but not recommended for production use.
+
+    For production use, we recommend using PostgreSQL.
     """
 
     database_url: str = env_field(name="DATABASE_URL")
     """
     Database URL that describes the connection to the database.
 
-    Defaults to sqlite:///{config.paths.db}/climate_ref.db".
+    Defaults to `sqlite:///{config.paths.db}/climate_ref.db`.
     This configuration value will be overridden by the `REF_DATABASE_URL` environment variable.
 
-    ## Schemas
+    **Schemas**
 
+    The following schemas are supported:
+    ```
     postgresql://USER:PASSWORD@HOST:PORT/NAME
+
     sqlite:///RELATIVE_PATH or sqlite:////ABS_PATH or sqlite:///:memory:
+    ```
     """
     run_migrations: bool = field(default=True)
 
@@ -285,12 +319,10 @@ def _load_config(config_file: str | Path, doc: dict[str, Any]) -> "Config":
     return _converter_defaults_relaxed.structure(doc, Config)
 
 
-@define
+@define(auto_attribs=True)
 class Config:
     """
-    REF configuration
-
-    This class is used to store the configuration of the REF application.
+    Configuration that is used by the REF
     """
 
     log_level: str = field(default="INFO")

{climate_ref-0.5.1 → climate_ref-0.5.2}/src/climate_ref/migrations/env.py

@@ -1,4 +1,3 @@
-import alembic_postgresql_enum  # noqa
 from alembic import context, op
 from loguru import logger
 from sqlalchemy import Connection, inspect
@@ -9,6 +8,11 @@ from climate_ref.models import Base, MetricValue
 from climate_ref_core.logging import capture_logging
 from climate_ref_core.pycmec.controlled_vocabulary import CV
 
+try:
+    import alembic_postgresql_enum  # noqa
+except ImportError:
+    logger.warning("alembic_postgresql_enum not installed, skipping enum migration support")
+
 # Setup logging
 capture_logging()
 logger.debug("Running alembic env")