glodformat 0.0.1__py3-none-any.whl

glodformat/__init__.py

@@ -0,0 +1,2 @@
+from glodformat.moon import validate_moon_observation
+from glodformat.srf import validate_srf, validate_srf_for_obs

glodformat/_version.py

@@ -0,0 +1,11 @@
+"""
+glodformat Version Handler Module
+
+Handles versioning for the `glodformat` package.
+"""
+from importlib.metadata import version, PackageNotFoundError
+
+try:
+    __version__ = version("glodformat")
+except PackageNotFoundError:
+    __version__ = "0.0.0"

glodformat/moon.py

@@ -0,0 +1,149 @@
+"""
+This module contains the functionality that validates moon observations files.
+
+It exports the following functions:
+    * validate_moon_observation - Validates that a xarray dataset follows the Moon Observation schema.
+"""
+from typing import Union
+import re
+from pathlib import Path
+
+import numpy as np
+import xarray as xr
+import pandera.xarray as pa
+
+from glodformat.netcdfcommon import (
+    validate_schema,
+    get_valid_metric_units,
+    check_stringy,
+    check_floating,
+    _as_ctx,
+)
+
+_check_shape_1 = pa.Check(
+    lambda da: da.size == 1, error="Coordinate 'date' must have exactly one element."
+)
+
+_UNITS_REGEX = "^(?:" + "|".join(re.escape(v) for v in get_valid_metric_units()) + ")$"
+
+_LUNAR_OBS_SCHEMA = pa.DatasetSchema(
+    data_vars={
+        "channel_name": pa.DataArraySchema(checks=check_stringy, dims=["chan"]),
+        "sat_pos": pa.DataArraySchema(
+            checks=check_floating,
+            shape=(3,),
+            dims=["sat_xyz"],
+            attrs={"units": _UNITS_REGEX},
+        ),
+        "sat_pos_ref": pa.DataArraySchema(checks=check_stringy, dims=[]),
+        "irr_obs": pa.DataArraySchema(
+            checks=check_floating, dims=["chan"], nullable=True
+        ),
+    },
+    coords={"date": pa.Coordinate(np.datetime64, checks=_check_shape_1)},
+    attrs={"data_source": lambda _: True},
+)
+
+_LUNAR_OBS_OTHER_SCHEMAS = [
+    pa.DatasetSchema(
+        data_vars={
+            "channel_name": pa.DataArraySchema(checks=check_stringy, dims=["chan"]),
+            "sat_pos": pa.DataArraySchema(
+                checks=check_floating,
+                shape=(3,),
+                dims=["sat_xyz"],
+                attrs={"units": _UNITS_REGEX},
+            ),
+            "sat_pos_ref": pa.DataArraySchema(checks=check_stringy, dims=[]),
+            "irr_obs": pa.DataArraySchema(
+                checks=check_floating, dims=["chan"], nullable=True
+            ),
+        },
+        coords={"date": pa.Coordinate(checks=[check_floating, _check_shape_1])},
+        attrs={"data_source": lambda _: True},
+    ),
+    pa.DatasetSchema(
+        data_vars={
+            "channel_name": pa.DataArraySchema(checks=check_stringy, dims=["chan"]),
+            "sat_pos": pa.DataArraySchema(
+                checks=check_floating,
+                shape=(3,),
+                dims=["sat_xyz"],
+                attrs={"units": _UNITS_REGEX},
+            ),
+            "sat_pos_ref": pa.DataArraySchema(checks=check_stringy, dims=[]),
+            "irr_obs": pa.DataArraySchema(
+                checks=check_floating, dims=["chan"], nullable=True
+            ),
+            "date": pa.DataArraySchema(np.datetime64, shape=(1,)),
+        },
+        attrs={"data_source": lambda _: True},
+    ),
+    pa.DatasetSchema(
+        data_vars={
+            "channel_name": pa.DataArraySchema(checks=check_stringy, dims=["chan"]),
+            "sat_pos": pa.DataArraySchema(
+                checks=check_floating,
+                shape=(3,),
+                dims=["sat_xyz"],
+                attrs={"units": _UNITS_REGEX},
+            ),
+            "sat_pos_ref": pa.DataArraySchema(checks=check_stringy, dims=[]),
+            "irr_obs": pa.DataArraySchema(
+                checks=check_floating, dims=["chan"], nullable=True
+            ),
+            "date": pa.DataArraySchema(checks=check_floating, shape=(1,)),
+        },
+        attrs={"data_source": lambda _: True},
+    ),
+]
+
+
+def _validate_schema_moon_observation(ds: xr.Dataset, strict: bool = False):
+    """Validates that a xarray dataset follows the Basic Moon Observation schema.
+
+    The dataset structure is:
+
+    coordinates: 'date': datetime
+    dims without coordinates: 'chan' and 'sat_xyz'
+    data_vars: 'channel_name': str, 'sat_pos': float, 'sat_pos_ref': str, 'irr_obs': float
+
+    Parameters
+    ----------
+    ds: xr.Dataset
+        Dataset to validate
+    strict: bool
+        Flag to specify if the check must be exact to the desired schema, or if
+        it can pass if it would work in most cases.
+    """
+    schema = _LUNAR_OBS_SCHEMA
+    if strict:
+        validate_schema(schema, ds)
+    else:
+        validate_schema(schema, ds, _LUNAR_OBS_OTHER_SCHEMAS)
+
+
+def validate_moon_observation(
+    data: Union[xr.Dataset, str, Path], strict: bool = False
+) -> None:
+    """Validates that a dataset follows the Moon Observation schema.
+
+    Parameters
+    ----------
+    data : xr.Dataset or str or pathlib.Path
+        Dataset to validate, or path to a NetCDF file that will be opened
+        and validated. If a path is given, the file is opened in read-only
+        mode and closed before returning.
+    strict : bool
+        Flag to specify if the check must be exact to the desired schema, or
+        if it can pass if it would work in most cases.
+
+    Raises
+    ------
+    TypeError
+        If ``data`` is neither an ``xr.Dataset``, ``str`` nor ``Path``.
+    ValueError
+        If the dataset does not conform to any of the accepted SRF schemas.
+    """
+    with _as_ctx(data) as ds:
+        _validate_schema_moon_observation(ds, strict=strict)

glodformat/netcdfcommon.py

@@ -0,0 +1,190 @@
+"""Common functionalities for reading netCDF files with `xarray`."""
+from typing import Iterable, Mapping, Union, Dict, List
+from pathlib import Path
+from contextlib import nullcontext
+
+import numpy as np
+import xarray as xr
+import pandera.xarray as pa
+
+
+def _is_stringy(da) -> bool:
+    dtype = da.dtype
+    if dtype.kind in ("U", "S"):
+        return True
+    if hasattr(np, "dtypes") and hasattr(np.dtypes, "StringDType"):
+        if isinstance(dtype, np.dtypes.StringDType):
+            return True
+    if dtype.kind == "O":
+        return all(isinstance(x, str) for x in da.values.flat)
+    return False
+
+
+check_stringy = pa.Check(_is_stringy, error="Data array must be of type string/bytes")
+
+
+def _is_floating(da) -> bool:
+    return da.dtype.kind == "f"
+
+
+check_floating = pa.Check(
+    _is_floating,
+    error="Data array must have a floating-point dtype (e.g. float32, float64).",
+)
+
+
+def _gen_unit_variations(basename: str) -> List[str]:
+    """Generate common variations of a metric unit (American & British spellings)."""
+    return [
+        f"{basename}metre",  # "metre" (British English)
+        f"{basename}meter",  # "meter" (American English)
+        f"{basename}metres",  # "metres" (plural British)
+        f"{basename}meters",  # "meters" (plural American)
+    ]
+
+
+def _get_metric_factors() -> Dict[str, int]:
+    # Build the metric factors dictionary efficiently
+    metric_factors = {
+        **dict.fromkeys(("nm", *_gen_unit_variations("nano")), -9),
+        **dict.fromkeys(("um", "μm", *_gen_unit_variations("micro")), -6),
+        **dict.fromkeys(("mm", *_gen_unit_variations("milli")), -3),
+        **dict.fromkeys(("cm", *_gen_unit_variations("centi")), -2),
+        **dict.fromkeys(("m", *_gen_unit_variations("")), 0),
+        **dict.fromkeys(("km", *_gen_unit_variations("kilo")), 3),
+    }
+    return metric_factors
+
+
+def get_valid_metric_units() -> List[str]:
+    metric_factors = _get_metric_factors()
+    return list(metric_factors.keys())
+
+
+def get_length_conversion_factor(from_unit: str, to_unit: str) -> float:
+    """
+    Get the conversion factor between two metric length units.
+
+    This function calculates the factor needed to convert a length measurement
+    from one metric unit to another. It supports various unit spellings, including
+    American and British English variations.
+
+    Parameters
+    ----------
+    from_unit : str
+        The original unit of measurement. Supported units include metres (m),
+        centimetres (cm), millimeters (mm), micrometres (μm / um), and nanometres (nm).
+    to_unit : str
+        The target unit of measurement. Must be one of the supported values listed above.
+
+    Returns
+    -------
+    float
+        The multiplication factor to convert from `from_unit` to `to_unit`.
+
+    Raises
+    ------
+    ValueError
+        If either `from_unit` or `to_unit` is not a recognized metric length unit.
+    """
+    metric_factors = _get_metric_factors()
+    if from_unit not in metric_factors:
+        raise ValueError(
+            f"Unsupported unit: {from_unit} or {to_unit}. Supported units: {list(metric_factors.keys())}"
+        )
+    factor = metric_factors[from_unit] - metric_factors[to_unit]
+    factor = 10**factor
+    return factor
+
+
+def xr_open_dataset(
+    filepath: str,
+    mask_fillvalue: Union[bool, Mapping[str, bool]] = True,
+    mask_limits: Union[bool, Mapping[str, bool]] = True,
+) -> xr.Dataset:
+    """Open a netCDF dataset as an xarray Dataset
+
+    Read the netCDF dataset masking the appropiate values, checking
+    against the variable attributes `_FillValue`, `valid_min` and `valid_max`.
+
+    Parameters
+    ----------
+    filepath: str
+        Path where the netCDF file is located
+    mask_fill_value: bool | Mapping[str, bool]
+        If True, tell `xarray` replace array values equal to `_FillValue` with `NA` and scale values.
+        Pass a mapping, e.g. {"my_variable": False}, to toggle this feature per-variable individually.
+        If a mapping is passed and a variable is missing, it's understood that the variable is mapped to True by default.
+    mask_limits: bool | Mapping[str, bool]
+        If True, replace array values lower than `valid_min` or higher than `valid_max` with `NA`, if present.
+        Pass a mapping, e.g. {"my_variable": False}, to toggle this feature per-variable individually.
+        If a mapping is passed and a variable is missing, it's understood that the variable is mapped to the default value.
+        The default value is the one defined for the "__default__" mapping, or True if not specified.
+
+    Returns
+    -------
+    ds: xr.Dataset
+        Dataset with the information of the netCDF file.
+    """
+    ds = xr.open_dataset(filepath, engine="netcdf4", mask_and_scale=mask_fillvalue)
+    if mask_limits is not False:
+        default = True
+        if not isinstance(mask_limits, bool):
+            default = mask_limits.get("__default__", True)
+        for vname, var in ds.data_vars.items():
+            mask_limits_var = False
+            if isinstance(mask_limits, bool):
+                mask_limits_var = mask_limits
+            else:
+                mask_limits_var = mask_limits.get(vname, default)
+            if mask_limits_var:
+                values = var.values
+                mask = np.ones(values.shape, dtype=bool)
+                if hasattr(var, "valid_min"):
+                    mask &= values >= var.valid_min
+                if hasattr(var, "valid_max"):
+                    mask &= values <= var.valid_max
+                var.values = np.where(mask, values, np.nan)
+    return ds
+
+
+def validate_schema(
+    dss: pa.DatasetSchema,
+    ds: xr.Dataset,
+    other_schemas: Iterable[pa.DatasetSchema] = None,
+):
+    """Validates the dataset `ds` against the schema `dss`.
+
+    Parameters
+    ----------
+    dss: pandera.xarray.DatasetSchema
+        Schema that the dataset is going to be validated against.
+    ds: xarray.Dataset
+        Dataset to validate.
+    other_schemas: Iterable[pandera.xarray.DatasetSchema]
+        If the dataset can have multiple schemas, it will be validated
+        against those before the canonical one. Once it succeeds in a validation,
+        it's understood as validated and finishes the validation.
+
+    Raises
+    ------
+    SchemaErrors
+        Error set indicating that the dataset is not following the schema.
+    """
+    if other_schemas is not None:
+        for odss in other_schemas:
+            try:
+                odss.validate(ds)
+                return
+            except pa.errors.SchemaError:
+                pass
+    dss.validate(ds, lazy=True)
+
+
+def _as_ctx(data: Union[xr.Dataset, str, Path]):
+    """Returns a context manager that produces an xr.Dataset."""
+    if isinstance(data, (str, Path)):
+        return xr.open_dataset(data)
+    if isinstance(data, xr.Dataset):
+        return nullcontext(data)
+    raise TypeError(f"expected xr.Dataset, str or Path, got {type(data).__name__}")

glodformat/srf.py

@@ -0,0 +1,205 @@
+"""
+This module contains the functionality that validates Spectral Response Function files
+from GLOD format files.
+
+It exports the following functions:
+    * validate_srf: Validates that a xarray dataset follows the SRF schema.
+"""
+from typing import Union
+from pathlib import Path
+import re
+
+import numpy as np
+import xarray as xr
+import pandera.xarray as pa
+
+from glodformat.netcdfcommon import (
+    validate_schema,
+    get_valid_metric_units,
+    check_floating,
+    check_stringy,
+    _as_ctx,
+)
+from glodformat import moon
+
+
+_UNITS_REGEX = "^(?:" + "|".join(re.escape(v) for v in get_valid_metric_units()) + ")$"
+
+_SRF_SCHEMA = pa.DatasetSchema(
+    data_vars={  # TODO check if None works in pandera
+        "srf": pa.DataArraySchema(
+            checks=check_floating, dims=[None, "channel"], nullable=True
+        ),
+        "wavelength": pa.DataArraySchema(
+            checks=check_floating,
+            dims=[None, "channel"],
+            attrs={"units": _UNITS_REGEX},
+            nullable=True,
+        ),
+        "channel_id": pa.DataArraySchema(checks=check_stringy),  # TODO check if works
+    },
+    coords={"channel": pa.Coordinate(checks=check_floating)},
+)
+
+_SRF_OTHER_SCHEMAS = [
+    pa.DatasetSchema(
+        data_vars={
+            "srf": pa.DataArraySchema(
+                checks=check_floating, dims=[None, "channel"], nullable=True
+            ),
+            "wavelength": pa.DataArraySchema(
+                checks=check_floating,
+                dims=[None, "channel"],
+                attrs={"units": _UNITS_REGEX},
+                nullable=True,
+            ),
+        },
+        coords={
+            "channel": pa.Coordinate(checks=check_floating),
+            "channel_id": pa.Coordinate(checks=check_stringy),
+        },
+    ),
+    pa.DatasetSchema(
+        data_vars={
+            "srf": pa.DataArraySchema(
+                checks=check_floating, dims=[None, None], nullable=True
+            ),
+            "wavelength": pa.DataArraySchema(
+                checks=check_floating,
+                dims=[None, None],
+                attrs={"units": _UNITS_REGEX},
+                nullable=True,
+            ),
+            "channel": pa.DataArraySchema(checks=check_floating),
+            "channel_id": pa.DataArraySchema(checks=check_stringy),
+        },
+    ),
+    pa.DatasetSchema(
+        data_vars={
+            "srf": pa.DataArraySchema(
+                checks=check_floating, dims=[None, "wavelength"], nullable=True
+            ),
+            "channel_id": pa.DataArraySchema(checks=check_stringy),
+        },
+        coords={
+            "channel": pa.Coordinate(checks=check_floating),
+            "wavelength": pa.Coordinate(checks=check_floating, nullable=True),
+        },
+        checks=[
+            pa.Check(
+                lambda ds: re.match(
+                    _UNITS_REGEX, ds.coords["wavelength"].attrs.get("units", "")
+                )
+            )
+        ],
+    ),
+]
+
+
+def _validate_schema_srf(ds: xr.Dataset, strict: bool = False):
+    """Validates that a xarray dataset follows the SRF schema.
+
+    The dataset structure is:
+
+    coordinates: 'channel': float
+    dims without coordinates: Any name, for example 'sample'.
+    data_vars: 'srf': float, 'wavelength': float, 'channel_id': str
+
+    Parameters
+    ----------
+    ds: xr.Dataset
+        Dataset to validate
+    strict: bool
+        Flag to specify if the check must be exact to the desired schema, or if
+        it can pass if it would work in most cases.
+    """
+    schema = _SRF_SCHEMA
+    if strict:
+        validate_schema(schema, ds)
+    else:
+        validate_schema(schema, ds, _SRF_OTHER_SCHEMAS)
+
+
+def validate_srf(data: Union[xr.Dataset, str, Path], strict: bool = False) -> None:
+    """Validates that a dataset follows the SRF schema.
+
+    Parameters
+    ----------
+    data : xr.Dataset or str or pathlib.Path
+        Dataset to validate, or path to a NetCDF file that will be opened
+        and validated. If a path is given, the file is opened in read-only
+        mode and closed before returning.
+    strict : bool
+        Flag to specify if the check must be exact to the desired schema, or
+        if it can pass if it would work in most cases.
+
+    Raises
+    ------
+    TypeError
+        If ``data`` is neither an ``xr.Dataset``, ``str`` nor ``Path``.
+    ValueError
+        If the dataset does not conform to any of the accepted SRF schemas.
+    """
+    with _as_ctx(data) as ds:
+        _validate_schema_srf(ds, strict=strict)
+
+
+def _validate_srf_for_obs(ds_srf: xr.Dataset, ds_obs: xr.Dataset) -> None:
+    def _channels(da: xr.DataArray) -> set[str]:
+        values = da.values
+        if values.dtype.kind == "S":  # bytes -> str
+            values = np.char.decode(values, "utf-8")
+        return {str(v).rstrip("\x00") for v in values}
+
+    obs_ch_names = _channels(ds_obs["channel_name"])
+    srf_channel_ids = _channels(ds_srf["channel_id"])
+
+    missing = obs_ch_names - srf_channel_ids
+    if not missing:
+        return
+
+    raise pa.errors.SchemaError(
+        schema=ds_srf,
+        data=ds_obs,
+        message=(
+            "SRF is missing channel_ids required by the observation data: "
+            f"{sorted(missing)}"
+        ),
+        check="srf_contains_obs_channels",
+        reason_code="DATA",
+    )
+
+
+def validate_srf_for_obs(
+    srf_data: Union[xr.Dataset, str, Path],
+    obs_data: Union[xr.Dataset, str, Path],
+    strict: bool = False,
+) -> None:
+    """Validates that a SRF dataset correctly represents the channels of an observation dataset.
+
+    Parameters
+    ----------
+    srf_data : xr.Dataset or str or pathlib.Path
+        SRF Dataset to validate, or path to a NetCDF file that will be opened
+        and validated. If a path is given, the file is opened in read-only
+        mode and closed before returning.
+    obs_data : xr.Dataset or str or pathlib.Path
+        Observation Dataset to validate, or path to a NetCDF file that will be opened
+        and validated. If a path is given, the file is opened in read-only
+        mode and closed before returning.
+    strict : bool
+        Prior to checking the channels, both datasets are validated independently.
+        This flag specifies if the check must be exact to the desired schema,
+        or if it can pass if it would work in most cases.
+
+    Raises
+    ------
+    TypeError
+        If ``data`` is neither an ``xr.Dataset``, ``str`` nor ``Path``.
+    ValueError
+        If the dataset does not conform to any of the accepted SRF schemas.
+    """
+    validate_srf(srf_data, strict)
+    moon.validate_moon_observation(obs_data, strict)
+    with _as_ctx(srf_data) as ds_srf, _as_ctx(obs_data) as ds_obs:
+        _validate_srf_for_obs(ds_srf, ds_obs)

glodformat/tests/test_moon.py

@@ -0,0 +1,18 @@
+"""Tests for moon module"""
+import unittest
+from importlib.resources import files, as_file
+
+from glodformat.moon import validate_moon_observation
+
+
+class TestMoon(unittest.TestCase):
+    def test_val_moon(self):
+        data_file = files("glodformat.tests").joinpath(
+            "data/W_XX-EUMETSAT-Darmstadt,VISNIR+SUBSET+MOON,MSG3+SEVIRI_C_EUMG_20140318140112_01.nc"
+        )
+        with as_file(data_file) as path:
+            validate_moon_observation(path, strict=True)
+
+
+if __name__ == "__main__":
+    unittest.main()

glodformat/tests/test_srf.py

@@ -0,0 +1,27 @@
+import unittest
+from importlib.resources import files, as_file
+
+from glodformat.srf import validate_srf, validate_srf_for_obs
+
+
+class TestSRF(unittest.TestCase):
+    def test_val_srf(self):
+        data_file = files("glodformat.tests").joinpath(
+            "data/W_XX-EUMETSAT-Darmstadt_VIS+IR+SRF_MSG3+SEVIRI_C_EUMG.nc"
+        )
+        with as_file(data_file) as path:
+            validate_srf(path, strict=True)
+
+    def test_val_srf_for_obs(self):
+        srf_file = files("glodformat.tests").joinpath(
+            "data/W_XX-EUMETSAT-Darmstadt_VIS+IR+SRF_MSG3+SEVIRI_C_EUMG.nc"
+        )
+        obs_file = files("glodformat.tests").joinpath(
+            "data/W_XX-EUMETSAT-Darmstadt,VISNIR+SUBSET+MOON,MSG3+SEVIRI_C_EUMG_20140318140112_01.nc"
+        )
+        with as_file(srf_file) as srf_path, as_file(obs_file) as obs_path:
+            validate_srf_for_obs(srf_path, obs_path, strict=True)
+
+
+if __name__ == "__main__":
+    unittest.main()

glodformat-0.0.1.dist-info/METADATA

@@ -0,0 +1,213 @@
+Metadata-Version: 2.4
+Name: glodformat
+Version: 0.0.1
+Summary: Reader and diagnostics toolkit for GLOD-based netCDF files.
+Author-email: Javier Gatón Herguedas <gaton@goa.uva.es>
+Maintainer-email: Javier Gatón Herguedas <gaton@goa.uva.es>
+License-Expression: LGPL-3.0-only
+Project-URL: Homepage, https://lime.uva.es
+Project-URL: Repository, https://github.com/LIME-ESA/glodformat.git
+Project-URL: Issues, https://github.com/LIME-ESA/glodformat/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Natural Language :: English
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering :: Astronomy
+Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: netcdf4~=1.7
+Requires-Dist: PyYAML~=6.0
+Requires-Dist: pandera~=0.36.0
+Requires-Dist: xarray>=2024.10.0
+Provides-Extra: dev
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx~=7.0; extra == "docs"
+Requires-Dist: sphinx_rtd_theme; extra == "docs"
+Requires-Dist: myst_parser; extra == "docs"
+Requires-Dist: sphinxcontrib-openapi; extra == "docs"
+Requires-Dist: linkify-it-py; extra == "docs"
+Dynamic: license-file
+
+[![Version 0.0.0](https://img.shields.io/badge/version-0.0.0-informational?style=for-the-badge)](https://github.com/LIME-ESA/glodformat/tags)
+[![License: LGPL 3.0][license-shield]][license-url]
+[![Issues][issues-shield]][issues-url]
+[![Stargazers][stars-shield]][stars-url]
+
+<!-- PROJECT LOGO -->
+<br />
+<div align="center">
+  <a href="https://lime.uva.es">
+    <img src="https://raw.githubusercontent.com/LIME-ESA/glodformat/main/docs/images/glodformat_logo.png" alt="glodformat logo" height="80" style="height: 80px !important;">
+  </a>
+
+  <h3 align="center">glodformat</h3>
+
+  <p align="center">
+    Reader and diagnostics toolkit for GLOD-based netCDF files.
+    <br />
+    <!--<a href="https://lime-esa.github.io/glodformat/"><strong>Explore the docs »</strong></a>-->
+    <br />
+  </p>
+</div>
+
+
+<!-- TABLE OF CONTENTS -->
+<details>
+  <summary>Table of Contents</summary>
+  <ol>
+    <li>
+      <a href="#about-the-project">About The Project</a>
+      <ul>
+        <li><a href="#collaborators">Collaborators</a></li>
+      </ul>
+    </li>
+    <li>
+      <a href="#getting-started">Getting Started</a>
+      <ul>
+        <li><a href="#prerequisites">Prerequisites</a></li>
+        <li><a href="#installation">Installation</a></li>
+      </ul>
+    </li>
+    <li><a href="#usage">Usage</a></li>
+    <li><a href="#roadmap">Roadmap</a></li>
+    <li>
+      <a href="#development-guide">Development Guide</a>
+      <ul>
+        <li><a href="#versioning">Versioning</a></li>
+        <li><a href="#setting-up-the-environment">Setting Up the Environment</a></li>
+        <li><a href="#testing">Testing</a></li>
+      </ul>
+    </li>
+    <li><a href="#license">License</a></li>
+    <li><a href="#authors">Authors</a></li>
+  </ol>
+</details>
+
+
+## About the project
+
+`glodformat` is a Python package that helps validate the format of netCDF files derived
+from GLOD and other specifications.
+
+This library was developed for the LIME Toolbox, under the LIME projects development efforts.
+More information about LIME can be found on [lime.uva.es](https://lime.uva.es).
+
+### Collaborators
+
+The LIME project is managed, financed and supported by the European Space
+Agency ([ESA](https://esa.int)).
+
+The project is a collaboration between multiple institutions, including:
+- [NPL](https://npl.co.uk) (National Physics Laboratory, United Kingdom)
+- [UVa](https://uva.es) (Universidad de Valladolid, Spain)
+- [VITO](https://vito.be) (Vlaamse Instelling voor Technologisch Onderzoek, Belgium)
+
+## Getting started
+
+### Prerequisites
+
+- Python >= 3.10
+
+### Installation
+
+The package is available at PyPI and can be installed with:
+```sh
+pip install glodformat
+```
+
+Another option is installing the python package and its dependencies
+directly from the cloned repository in editable mode by using:
+```sh
+pip install -e .
+```
+
+## Usage
+
+```python
+import glodformat
+
+# Functions accept both paths or loaded xarray datasets
+glodformat.validate_srf("response.nc")
+glodformat.validate_moon_observation("moon_obs.nc")
+glodformat.validate_srf_for_obs("response.nc", "moon_obs.nc")
+```
+
+## Roadmap
+
+- [ ] Fully support checking if an observation file is correctly represented by a SRF file
+- [ ] Add support for LIME Toolbox related formats
+
+## Development Guide
+
+### Versioning
+
+Version changes and descriptions are stored in the <a href="./CHANGELOG.md">CHANGELOG</a>.
+This file is updated each time a new version is released.
+
+### Setting Up the Environment
+
+To prepare your environment for development, testing or deployment, follow these steps:
+
+1. **Install Pre-commit Hooks**
+    Install the `pre-commit` hooks to automatically check code styling:
+    ```sh
+    pre-commit install  
+    ```
+
+    - When you commit changes, `black` will check your code for styling errors.
+    - If errors are found, they will be corrected, and the commit will be aborted to allow you to review the changes.
+    - If you're satisfied, reattempt the commit.
+
+2. **Install Python Dependencies**
+
+    Install the python package dependencies listed in the `requirements.txt` file, preferably in a python virtual enironment:
+    ```sh
+    pip install -r requirements.txt  
+    ```
+
+### Testing
+
+Run the following commands to ensure the code works as expected:
+
+1. **Unit Tests**  
+    To perform unit tests:
+    ```sh
+    python3 -m unittest  
+    ```
+
+
+## License
+
+Distributed under the LGPL-v3 License. See [LGPL v3](./LICENSE) for more information.
+
+
+## Acknowledgements
+
+* [Javier Gatón Herguedas](mailto:gaton@goa.uva.es) - [GOA-UVa](https://goa.uva.es)
+* [Pieter De Vis](mailto:pieter.de.vis@npl.co.uk) - [NPL](https://npl.co.uk)
+* [Stefan Adriaensen](mailto:stefan.adriaensen@vito.be) - [VITO](https://vito.be)
+* [Jacob Fahy](mailto:jacob.fahy@npl.co.uk) - [NPL](https://npl.co.uk)
+* [Ramiro González Catón](mailto:ramiro@goa.uva.es) - [GOA-UVa](https://goa.uva.es)
+* [Carlos Toledano](mailto:toledano@goa.uva.es) - [GOA-UVa](https://goa.uva.es)
+* [África Barreto](mailto:abarretov@aemet.es) - [AEMET](https://aemet.es)
+* [Agnieszka Bialek](mailto:agnieszka.bialek@npl.co.uk) - [NPL](https://npl.co.uk)
+* [Marc Bouvet](mailto:marc.bouvet@esa.int) - [ESA](https://esa.int)
+
+[stars-shield]: https://img.shields.io/github/stars/LIME-ESA/glodformat.svg?style=for-the-badge
+[stars-url]: https://github.com/LIME-ESA/glodformat/stargazers
+[issues-shield]: https://img.shields.io/github/issues/LIME-ESA/glodformat.svg?style=for-the-badge
+[issues-url]: https://github.com/LIME-ESA/glodformat/issues
+[license-shield]: https://img.shields.io/github/license/LIME-ESA/glodformat.svg?style=for-the-badge
+[license-url]: https://github.com/LIME-ESA/glodformat/blob/main/LICENSE

glodformat-0.0.1.dist-info/RECORD

@@ -0,0 +1,15 @@
+glodformat/__init__.py,sha256=Kbx2Pm0dxZOfhZSoAMG9uO_60o887YnICmrlPjNLwTg,116
+glodformat/_version.py,sha256=6Fr5RRjm7dcNtKqECuaZKcxVk8ULxysaxd4Wt1wFjMo,254
+glodformat/moon.py,sha256=RnwrX-5-ODF_K_7j4hRBcagLJfXb_F7eRSZZUP2vTwo,5043
+glodformat/netcdfcommon.py,sha256=lqDJtof8XaifNOTrc5ETuvFEYRhntEjFsf8_ncrhm18,6924
+glodformat/srf.py,sha256=b1il5tgpBbXdCK7vMt59vEWoTDPyLePMAwKkl9Eecl0,6695
+glodformat/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+glodformat/tests/test_moon.py,sha256=GHh8omMqNQ7FZsXUb8zfdoPiyO7-C6-LAZM5nBWwu-Y,527
+glodformat/tests/test_srf.py,sha256=lfyKfuP4Oc1hOQfLTn4ANrwtTs-HKuTE3IvltK-dMos,952
+"glodformat/tests/data/W_XX-EUMETSAT-Darmstadt,VISNIR+SUBSET+MOON,MSG3+SEVIRI_C_EUMG_20140318140112_01.nc",sha256=9RwunNtejAwKOGE_yb6iR7HNDp6ypXX25m5gtfmXvT8,252693
+glodformat/tests/data/W_XX-EUMETSAT-Darmstadt_VIS+IR+SRF_MSG3+SEVIRI_C_EUMG.nc,sha256=K8NonT30emxud-er42PdWCcsfr-22tcQjWbjYU5InTo,62918
+glodformat-0.0.1.dist-info/licenses/LICENSE,sha256=46mU2C5kSwOnkqkw9XQAJlhBL2JAf1_uCD8lVcXyMRg,7652
+glodformat-0.0.1.dist-info/METADATA,sha256=xLNPYMpP-mcEwA5Iq4jCJYOSqOQ3IsenMon1a0hh4jM,7367
+glodformat-0.0.1.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+glodformat-0.0.1.dist-info/top_level.txt,sha256=Eznz5y9S10OcJviz7wFkEo_blPEprE7WNiOrmu-rSic,11
+glodformat-0.0.1.dist-info/RECORD,,

glodformat-0.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

glodformat-0.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

glodformat-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+glodformat