esgvoc 0.4.0__tar.gz → 1.0.0__tar.gz

{esgvoc-0.4.0 → esgvoc-1.0.0}/.github/workflows/docs.yml

@@ -11,22 +11,24 @@ on:
 
 jobs:
   documentation:
+    name: Publish documentation
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout
+        uses: actions/checkout@v4
 
-      - name: Install the latest version of rye
-        uses: eifinger/setup-rye@v4
+      - name: Install UV
+        uses: astral-sh/setup-uv@v5
         with:
           enable-cache: true
 
-      - name: Sync dependencies
-        run: rye sync
+      - name: Sync
+        run: uv sync
 
-      - name: build
+      - name: Build
         run: docs/build.sh
 
-      - name: deploy
+      - name: Deploy
         uses: peaceiris/actions-gh-pages@v3
         if: ${{ github.ref == 'refs/heads/documentation' }}
         with:

{esgvoc-0.4.0 → esgvoc-1.0.0}/.github/workflows/pypi-publish.yml

@@ -8,7 +8,7 @@ on:
 
 jobs:
   pypi-publish:
-    name: upload release to PyPI
+    name: Publish new release
     runs-on: ubuntu-latest
     permissions:
       # This permission is needed for private repositories.
@@ -16,18 +16,19 @@ jobs:
       # IMPORTANT: this permission is mandatory for trusted publishing
       id-token: write
     steps:
-      - uses: actions/checkout@v3
+      - name: Checkout
+        uses: actions/checkout@v4
 
-      - name: Install the latest version of rye
-        uses: eifinger/setup-rye@v4
+      - name: Install UV
+        uses: astral-sh/setup-uv@v5
         with:
           enable-cache: true
 
-      - name: Sync dependencies
-        run: rye sync
+      - name: Sync
+        run: uv sync
 
-      - name: Build package
-        run: rye build
+      - name: Build
+        run: uv build
 
-      - name: Publish package distributions to PyPI
+      - name: Upload
         uses: pypa/gh-action-pypi-publish@release/v1

esgvoc-1.0.0/.github/workflows/unit_tests.yml

@@ -0,0 +1,34 @@
+name: Unit tests
+
+on:
+  push:
+    branches:
+      - integration
+    paths:
+      - src/**
+      - tests/**
+  pull_request:
+    branches:
+      - main
+    paths:
+      - src/**
+      - tests/**
+
+jobs:
+  unit_tests:
+    name: Run unit tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install UV
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Sync
+        run: uv sync
+
+      - name: Test
+        run: uv run pytest tests

{esgvoc-0.4.0 → esgvoc-1.0.0}/.gitignore

@@ -28,3 +28,4 @@ tmp*
 sb.py
 CHANGELOG.md
 .coverage
+codemcp.toml

{esgvoc-0.4.0 → esgvoc-1.0.0}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.3
 Name: esgvoc
-Version: 0.4.0
+Version: 1.0.0
 Summary: python library and CLI to interact with WCRP CVs
 Project-URL: Repository, https://github.com/ESGF/esgf-vocab
 Author-email: Sébastien Gardoll <sebastien@gardoll.fr>, Guillaume Levavasseur <guillaume.levavasseur@ipsl.fr>, Laurent Troussellier <laurent.troussellier@ipsl.fr>
 License: CECILL-2.1
-Requires-Python: <3.13,>=3.12
+Requires-Python: >=3.10
 Requires-Dist: idna>=3.10
 Requires-Dist: platformdirs>=4.3.6
 Requires-Dist: pydantic>=2.9.2
@@ -58,32 +58,19 @@ esgvoc install
 
 ## How to contribute
 
-### Install Python dev environment
-
 * Pip
 
 ```bash
 pip install -e .
-```
-
-* Rye
-
-```bash
-rye sync
-```
-
-### Linters & code formatters
-
-* Pip
-
-```bash
+wily setup
 pip install pre-commit
 pre-commit install
 ```
 
-* Rye
+* UV
 
 ```bash
-rye install
-rye run pre-commit install
+uv sync
+uv run wily setup
+uv run pre-commit install
 ```

{esgvoc-0.4.0 → esgvoc-1.0.0}/README.md

@@ -39,32 +39,19 @@ esgvoc install
 
 ## How to contribute
 
-### Install Python dev environment
-
 * Pip
 
 ```bash
 pip install -e .
-```
-
-* Rye
-
-```bash
-rye sync
-```
-
-### Linters & code formatters
-
-* Pip
-
-```bash
+wily setup
 pip install pre-commit
 pre-commit install
 ```
 
-* Rye
+* UV
 
 ```bash
-rye install
-rye run pre-commit install
+uv sync
+uv run wily setup
+uv run pre-commit install
 ```

esgvoc-1.0.0/docs/source/api_documentation/jsg.md

@@ -0,0 +1,7 @@
+# Json schema generator
+
+```{eval-rst}
+.. automodule:: esgvoc.apps.jsg.json_schema_generator
+   :members:
+   :member-order: groupwise
+```

{esgvoc-0.4.0 → esgvoc-1.0.0}/docs/source/index.md

@@ -111,7 +111,8 @@ guides/basics_drs.ipynb
 api_documentation/universe.md
 api_documentation/projects.md
 api_documentation/project_specs.md
-api_documentation/drs.md
 api_documentation/data_descriptors.md
+api_documentation/drs.md
+api_documentation/jsg.md
 api_documentation/miscellaneous.md
 ```

{esgvoc-0.4.0 → esgvoc-1.0.0}/docs/source/user/introduction.md

@@ -26,12 +26,12 @@ Previously, controlled vocabularies were stored in multiple locations and format
 
 You can install `ESGVOC` using recent Python packaging tools. It is only available in pypi.org (not in anaconda.org). We recommend the following methods:
 
-### Using Rye (preferred)
+### Using UV (preferred)
 
-[Rye](https://rye-up.com/) is recommended for managing dependencies and isolating the library:
+[UV](https://docs.astral.sh/uv/) is recommended for managing dependencies and isolating the library:
 
 ```bash
-rye add esgvoc
+uv add esgvoc
 ```
 
 This ensures all dependencies are installed, and cached repositories and databases will be stored in the `.cache` directory alongside the `.venv` folder. This approach simplifies updates and uninstallation.

{esgvoc-0.4.0 → esgvoc-1.0.0}/pyproject.toml

@@ -23,7 +23,7 @@ dependencies = [
     "platformdirs>=4.3.6",
 ]
 readme = "README.md"
-requires-python = ">= 3.12, <3.13"
+requires-python = ">= 3.10"
 
 [build-system]
 requires = ["hatchling==1.26.3"]
@@ -37,21 +37,14 @@ esgvoc = "esgvoc.cli.main:main"
 
 ######## TOOLS ########
 
-[tool.rye.scripts]
-ev = { cmd = "python src/esgvoc/cli/main.py" }
-evc = { cmd = "python src/esgvoc/cli/main.py config" }
-evcp = { cmd = "python src/esgvoc/cli/main.py config projects." }
-evg = { cmd = "python src/esgvoc/cli/main.py get" }
-evs = {cmd = "python src/esgvoc/cli/main.py status"}
-evv = {cmd = "python src/esgvoc/cli/main.py valid"}
-
-[tool.rye]
+[tool.uv]
 managed = true
-dev-dependencies = [
-    "pytest>=8.3.3",
+default-groups = "all"
+
+[dependency-groups]
+dev = [
     "jupyter-console>=6.6.3",
-    "mypy>=1.13.0",
-    "pytest-mock>=3.14.0",
+    "hatch>=1.14.0", # Required for version updating through uv.
     "sphinx>=8.1.3",
     "sphinx-book-theme>=1.1.3",
     "autodoc-pydantic>=2.2.0",
@@ -59,12 +52,14 @@ dev-dependencies = [
     "sphinx-tabs>=3.4.7",
     "sphinx-copybutton>=0.5.2",
     "pre-commit>=4.1.0",
-    "hatch>=1.14.0", # Required for version updating through rye.
-    "pytest-cov>=6.0.0",
-    "wily>=1.25.0",
     "flake8>=7.1.2",
+    "wily>=1.25.0",
     "ruff>=0.11.0",
     "pyright>=1.1.396",
+    "mypy>=1.13.0",
+    "pytest>=8.3.5",
+    "pytest-mock>=3.14.0",
+    "pytest-cov>=6.0.0",
 ]
 
 [tool.hatch.metadata]

{esgvoc-0.4.0 → esgvoc-1.0.0}/src/esgvoc/__init__.py

@@ -1,3 +1,3 @@
 import esgvoc.core.logging_handler  # noqa
 
-__version__ = "0.4.0"
+__version__ = "1.0.0"

{esgvoc-0.4.0 → esgvoc-1.0.0}/src/esgvoc/api/data_descriptors/__init__.py

@@ -1,69 +1,91 @@
 from esgvoc.api.data_descriptors.activity import Activity
+from esgvoc.api.data_descriptors.area_label import AreaLabel
+from esgvoc.api.data_descriptors.branded_suffix import BrandedSuffix
+from esgvoc.api.data_descriptors.branded_variable import BrandedVariable
 from esgvoc.api.data_descriptors.consortium import Consortium
+from esgvoc.api.data_descriptors.contact import Contact
+from esgvoc.api.data_descriptors.conventions import Convention
+from esgvoc.api.data_descriptors.creation_date import CreationDate
 from esgvoc.api.data_descriptors.data_descriptor import DataDescriptor
+from esgvoc.api.data_descriptors.data_specs_version import DataSpecsVersion
 from esgvoc.api.data_descriptors.date import Date
 from esgvoc.api.data_descriptors.directory_date import DirectoryDate
-from esgvoc.api.data_descriptors.experiment import Experiment 
+from esgvoc.api.data_descriptors.experiment import Experiment
 from esgvoc.api.data_descriptors.forcing_index import ForcingIndex
 from esgvoc.api.data_descriptors.frequency import Frequency
-from esgvoc.api.data_descriptors.grid_label import GridLabel 
-from esgvoc.api.data_descriptors.initialisation_index import InitialisationIndex 
+from esgvoc.api.data_descriptors.further_info_url import FurtherInfoUrl
+from esgvoc.api.data_descriptors.grid_label import GridLabel
+from esgvoc.api.data_descriptors.horizontal_label import HorizontalLabel
+from esgvoc.api.data_descriptors.initialisation_index import InitialisationIndex
 from esgvoc.api.data_descriptors.institution import Institution
-from esgvoc.api.data_descriptors.license import License 
+from esgvoc.api.data_descriptors.known_branded_variable import KnownBrandedVariable
+from esgvoc.api.data_descriptors.license import License
 from esgvoc.api.data_descriptors.mip_era import MipEra
 from esgvoc.api.data_descriptors.model_component import ModelComponent
-from esgvoc.api.data_descriptors.organisation import Organisation 
+from esgvoc.api.data_descriptors.obs_type import ObsType
+from esgvoc.api.data_descriptors.organisation import Organisation
 from esgvoc.api.data_descriptors.physic_index import PhysicIndex
 from esgvoc.api.data_descriptors.product import Product
-from esgvoc.api.data_descriptors.realisation_index import RealisationIndex 
+from esgvoc.api.data_descriptors.publication_status import PublicationStatus
+from esgvoc.api.data_descriptors.realisation_index import RealisationIndex
 from esgvoc.api.data_descriptors.realm import Realm
+from esgvoc.api.data_descriptors.region import Region
 from esgvoc.api.data_descriptors.resolution import Resolution
-from esgvoc.api.data_descriptors.source import Source 
-from esgvoc.api.data_descriptors.source_type import SourceType 
+from esgvoc.api.data_descriptors.source import Source
+from esgvoc.api.data_descriptors.source_type import SourceType
 from esgvoc.api.data_descriptors.sub_experiment import SubExperiment
-from esgvoc.api.data_descriptors.table import Table 
-from esgvoc.api.data_descriptors.time_range import TimeRange 
+from esgvoc.api.data_descriptors.table import Table
+from esgvoc.api.data_descriptors.temporal_label import TemporalLabel
+from esgvoc.api.data_descriptors.time_range import TimeRange
+from esgvoc.api.data_descriptors.title import Title
+from esgvoc.api.data_descriptors.tracking_id import TrackingId
 from esgvoc.api.data_descriptors.variable import Variable
 from esgvoc.api.data_descriptors.variant_label import VariantLabel
-from esgvoc.api.data_descriptors.area_label import AreaLabel
 from esgvoc.api.data_descriptors.vertical_label import VerticalLabel
-from esgvoc.api.data_descriptors.horizontal_label import HorizontalLabel
-from esgvoc.api.data_descriptors.temporal_label import TemporalLabel
-from esgvoc.api.data_descriptors.branded_suffix import BrandedSuffix
-from esgvoc.api.data_descriptors.branded_variable import BrandedVariable
 
 DATA_DESCRIPTOR_CLASS_MAPPING: dict[str, type[DataDescriptor]] = {
     "activity": Activity,
     "consortium": Consortium,
     "date": Date,
     "directory_date": DirectoryDate,
-    "experiment": Experiment, 
+    "experiment": Experiment,
     "forcing_index": ForcingIndex,
     "frequency": Frequency,
-    "grid": GridLabel,#Universe
-    "grid_label": GridLabel, # cmip6, cmip6plus
-    "initialisation_index": InitialisationIndex, 
+    "grid": GridLabel,  # Universe
+    "grid_label": GridLabel,  # cmip6, cmip6plus
+    "initialisation_index": InitialisationIndex,
     "institution": Institution,
     "license": License,
     "mip_era": MipEra,
     "model_component": ModelComponent,
-    "organisation": Organisation, 
+    "organisation": Organisation,
     "physic_index": PhysicIndex,
     "product": Product,
-    "realisation_index": RealisationIndex ,
+    "realisation_index": RealisationIndex,
     "realm": Realm,
     "resolution": Resolution,
-    "source": Source, 
-    "source_type": SourceType, 
+    "source": Source,
+    "source_type": SourceType,
     "sub_experiment": SubExperiment,
-    "table" : Table,
+    "table": Table,
     "time_range": TimeRange,
     "variable": Variable,
     "variant_label": VariantLabel,
     "area_label": AreaLabel,
     "temporal_label": TemporalLabel,
-    "vertical_label" : VerticalLabel,
-    "horizontal_label" : HorizontalLabel,
-    "branded_suffix" : BrandedSuffix,
-    "branded_variable" : BrandedVariable
+    "vertical_label": VerticalLabel,
+    "horizontal_label": HorizontalLabel,
+    "branded_suffix": BrandedSuffix,
+    "branded_variable": BrandedVariable,
+    "publication_status": PublicationStatus,
+    "known_branded_variable": KnownBrandedVariable,
+    "data_specs_version": DataSpecsVersion,
+    "further_info_url": FurtherInfoUrl,
+    "tracking_id": TrackingId,
+    "creation_date": CreationDate,
+    "conventions": Convention,
+    "title": Title,
+    "contact": Contact,
+    "region": Region,
+    "obs_type": ObsType,  # obs4Mips
 }

{esgvoc-0.4.0 → esgvoc-1.0.0}/src/esgvoc/api/data_descriptors/activity.py

@@ -9,6 +9,6 @@ class Activity(PlainTermDataDescriptor):
     Activities are often organized around key research themes and may involve multiple experiments, \
     scenarios, and model configurations.
     """
-    name: str 
-    long_name: str 
-    url: str|None
+    name: str
+    long_name: str
+    url: str | None

esgvoc-1.0.0/src/esgvoc/api/data_descriptors/area_label.py

@@ -0,0 +1,21 @@
+from esgvoc.api.data_descriptors.data_descriptor import PlainTermDataDescriptor
+
+
+class AreaLabel(PlainTermDataDescriptor):
+    """
+    Area sampling label.
+
+    This label provides information about the area sampling of a given dataset.
+    For a list of allowed values, see
+    [TODO think about how to cross-reference to somewhere where people can look up the allowed values,
+    e.g. some summary of the values in https://github.com/WCRP-CMIP/WCRP-universe/tree/esgvoc/area_label.]
+
+    This label is used as the area component of a branded variable's suffix
+    (see :py:class:`BrandedSuffix`).
+    By definition, the area label must be consistent with the branded suffix.
+    area labels must not contain dashes
+    (as the dash is used as a separator when constructing the branded suffix).
+    """
+
+    description: str
+    label: str

esgvoc-1.0.0/src/esgvoc/api/data_descriptors/branded_suffix.py

@@ -0,0 +1,25 @@
+from esgvoc.api.data_descriptors.data_descriptor import CompositeTermDataDescriptor
+
+
+class BrandedSuffix(CompositeTermDataDescriptor):
+    """
+    The suffix of a branded variable.
+
+    A branded variable is composed of two parts.
+    The first part is the root variable (see [TODO cross-ref to Variable]).
+    The second is the suffix, i.e. the component described here.
+    The suffix captures all the information
+    about the time sampling, horizontal sampling, vertical sampling
+    and area masking of the variable.
+
+    The suffix is composed of the following components:
+
+    #. :py:class:`TemporalLabel`
+    #. :py:class:`VerticalLabel`
+    #. :py:class:`HorizontalLabel`
+    #. :py:class:`AreaLabel`
+
+    These components are separated by a separator to create the branded suffix.
+    """
+
+    description: str

esgvoc-1.0.0/src/esgvoc/api/data_descriptors/branded_variable.py

@@ -0,0 +1,17 @@
+from esgvoc.api.data_descriptors.data_descriptor import CompositeTermDataDescriptor
+
+
+class BrandedVariable(CompositeTermDataDescriptor):
+    """
+    A climate-related quantity or measurement, including information about sampling.
+
+    The concept of a branded variable was introduced in CMIP7.
+    A branded variable is composed of two parts.
+    The first part is the root variable (see :py:class:`Variable`).
+    The second is the suffix (see :py:class:`BrandedSuffix`).
+
+    For further details on the development of branded variables,
+    see [this paper draft](https://docs.google.com/document/d/19jzecgymgiiEsTDzaaqeLP6pTvLT-NzCMaq-wu-QoOc/edit?pli=1&tab=t.0).
+    """
+
+    description: str

esgvoc-1.0.0/src/esgvoc/api/data_descriptors/consortium.py

@@ -0,0 +1,27 @@
+from pydantic import Field
+
+from esgvoc.api.data_descriptors.data_descriptor import ConfiguredBaseModel, PlainTermDataDescriptor
+
+
+class Dates(ConfiguredBaseModel):
+    phase: str
+    from_: int = Field(..., alias="from")  # Cause from is a keyword
+    to: int | str
+
+
+class Member(ConfiguredBaseModel):
+    type: str
+    institution: str  # id
+    dates: list[Dates] = Field(default_factory=list)
+    membership_type: str  # prior, current
+
+
+class Consortium(PlainTermDataDescriptor):
+    validation_method: str = Field(default="list")
+    name: str | None = None
+    status: str | None = None
+    changes: str | None
+    members: list[Member] = Field(default_factory=list)
+    url: str | None
+    # TODO: remove default value when all json will have their description.
+    description: str = Field(default="")

esgvoc-0.4.0/src/esgvoc/api/data_descriptors/vertical_label.py → esgvoc-1.0.0/src/esgvoc/api/data_descriptors/contact.py

@@ -1,5 +1,5 @@
 from esgvoc.api.data_descriptors.data_descriptor import PatternTermDataDescriptor
 
 
-class VerticalLabel(PatternTermDataDescriptor):
+class Contact(PatternTermDataDescriptor):
     pass

esgvoc-0.4.0/src/esgvoc/api/data_descriptors/area_label.py → esgvoc-1.0.0/src/esgvoc/api/data_descriptors/conventions.py

@@ -1,6 +1,6 @@
 from esgvoc.api.data_descriptors.data_descriptor import PlainTermDataDescriptor
 
 
-class AreaLabel(PlainTermDataDescriptor):
+class Convention(PlainTermDataDescriptor):
     description: str
-    label: str 
+    label: str

esgvoc-1.0.0/src/esgvoc/api/data_descriptors/creation_date.py

@@ -0,0 +1,5 @@
+from esgvoc.api.data_descriptors.data_descriptor import PatternTermDataDescriptor
+
+
+class CreationDate(PatternTermDataDescriptor):
+    pass

{esgvoc-0.4.0 → esgvoc-1.0.0}/src/esgvoc/api/data_descriptors/data_descriptor.py

@@ -1,16 +1,17 @@
-from typing import Protocol, Any, ClassVar
 from abc import ABC, abstractmethod
+from typing import Any, ClassVar, Protocol
+
 from pydantic import BaseModel, ConfigDict
 
 
 class ConfiguredBaseModel(BaseModel):
     model_config = ConfigDict(
-        validate_assignment = True,
-        validate_default = True,
-        extra = "allow",
-        arbitrary_types_allowed = True,
-        use_enum_values = True,
-        strict = False,
+        validate_assignment=True,
+        validate_default=True,
+        extra="allow",
+        arbitrary_types_allowed=True,
+        use_enum_values=True,
+        strict=False,
     )
 
 
@@ -21,12 +22,15 @@ class DataDescriptorVisitor(Protocol):
     def visit_sub_set_term(self, term: "DataDescriptorSubSet") -> Any:
         """Visit a sub set of the information of a term."""
         pass
+
     def visit_plain_term(self, term: "PlainTermDataDescriptor") -> Any:
         """Visit a plain term."""
         pass
+
     def visit_pattern_term(self, term: "PatternTermDataDescriptor") -> Any:
         """Visit a pattern term."""
         pass
+
     def visit_composite_term(self, term: "CompositeTermDataDescriptor") -> Any:
         """Visit a composite term."""
 
@@ -68,6 +72,7 @@ class PlainTermDataDescriptor(DataDescriptor):
     A data descriptor that describes hand written terms.
     """
     drs_name: str
+
     def accept(self, visitor: DataDescriptorVisitor) -> Any:
         return visitor.visit_plain_term(self)
 
@@ -86,11 +91,11 @@ class CompositeTermPart(ConfiguredBaseModel):
     """
     A reference to a term, part of a composite term.
     """
-    id: str
+    id: str | list[str] | None = None
     """The id of the referenced term."""
     type: str
     """The type of the referenced term."""
-    is_required : bool
+    is_required: bool
     """Denote if the term is optional as part of a composite term."""
 
 

esgvoc-1.0.0/src/esgvoc/api/data_descriptors/data_specs_version.py

@@ -0,0 +1,5 @@
+from esgvoc.api.data_descriptors.data_descriptor import PatternTermDataDescriptor
+
+
+class DataSpecsVersion(PatternTermDataDescriptor):
+    pass

{esgvoc-0.4.0 → esgvoc-1.0.0}/src/esgvoc/api/data_descriptors/date.py

@@ -2,4 +2,4 @@ from esgvoc.api.data_descriptors.data_descriptor import PatternTermDataDescripto
 
 
 class Date(PatternTermDataDescriptor):
-    pass
+    pass

{esgvoc-0.4.0 → esgvoc-1.0.0}/src/esgvoc/api/data_descriptors/directory_date.py

@@ -2,4 +2,4 @@ from esgvoc.api.data_descriptors.data_descriptor import PatternTermDataDescripto
 
 
 class DirectoryDate(PatternTermDataDescriptor):
-    pass
+    pass