Skip to content

0.5.0

Choose a tag to compare

View all tags
@forman forman released this 13 Feb 08:12
· 15 commits to main since this release
v0.5.0
8007da6
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

What's Changed

Adjustments and Enhancements

  • Added support for validating Zarr and HDF-5 groups and their items.
    Rules can now validate xarray.DataTree objects originating
    from xarray.open_datatree() by implementing
    rule operation method RuleOp.validate_datatree(ctx, node). (#54)

  • Added a new core rule var-missing-data that checks for the recommended
    use of a variable's missing data.

  • Added a new core rule access-latency that can be used to check the
    time it takes to open a dataset.

  • Added HTML styling for both CLI output (--format html) and rendering
    of Result objects in Jupyter notebooks.

  • Rule no-empty-chunks has been taken off the "recommended" settings
    as there is no easy/efficient way to tell whether a dataset has
    been written using write_emtpy_chunks option or not.
    The rule message itself has been fixed. (#45)

  • Adjusted messages of rules var-units and time-coordinate
    to be consistent with messages of other rules.

  • Core rule dataset-title-attr has been moved into xcube plugin
    and renamed to xcube/dataset-title because the core rule
    content-desc covers checking for dataset titles and other descriptive
    attributes.

Incompatible API changes

  • Changed general use of term verify into validate:

    • prefixed RuleOp methods by validate_ for clarity.
    • renamed XRLint.verify_datasets() into validate_files()
    • renamed Lint.verify_dataset() into validate()

  • Renamed nodes and node properties for clarity and consistency:

    • renamed DataArrayNode into VariableNode
    • renamed DataArrayNode.data_array into VariableNode.array

  • Various changes for improved clarity regarding configuration management:

    • introduced type aliases ConfigLike and ConfigObjectLike.
    • renamed Config into ConfigObject
    • renamed ConfigList.configs into config_objects
    • renamed ConfigList into Config
    • renamed ConfigList.compute_config() into compute_config_object()
    • renamed Result.config into config_object
    • renamed XRLint.load_config_list() into init_config()
    • added class method from_config() to ConfigList.
    • removed function xrlint.config.merge_configs as it was no longer used.

  • Removed class method Result.new() as it was no longer used.

Other changes

  • XRLint now works with zarr >=2,<3 and zarr >=3.0.2
  • Added more tests so we finally reached 100% coverage.
  • New PluginMeta.docs_url property.
  • Inserted copyright header into all source files.

Full Changelog: v0.4.1...v0.5.0

Assets 2
Loading