CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Common Changelog, and this project adheres to Semantic Versioning.

[1.12.0] - 2024-12-20

Changed

• Clean up docstrings, especially removing types that are already annotated in function signature (#274) (@danielfromearth)

Added

• Categorize counts of differences (including attributes) in a summary (#276) (@danielfromearth)
• Include dimensions in variable attribute comparisons (#277) (@danielfromearth)
• Provide numerical output where zero means no differences found (#278) (@danielfromearth)

Removed

• Breaking: drop support for randomized value checks, which are no longer part of API (#271) (@danielfromearth)

Fixed

• Catch "unsupported datatype" exception from netCDF library (#268) (@danielfromearth)

[1.11.0] - 2024-11-14

Added

• Add pre-commit autoupdating (#cde1ae4) (@danielfromearth)
• Add gitleaks to pre-commit (#261) (@danielfromearth)

Removed

• Remove usage of black for code formatting (#257) (@danielfromearth)

[1.10.0] - 2024-07-10

Changed

• Group dependabot updates into fewer PRs (#233) (@danielfromearth)
• Change xarray Dataset.dims reference to Dataset.sizes due to FutureWarning (#246)(@nannau)

Added

• Add Journal of Open Source Software (JOSS) info to README and CITATION docs (#229) (@danielfromearth)
• Make available via conda and add conda/mamba installation instructions to README.md (#42) (@jhkennedy, @danielfromearth)

Removed

• Remove upper bounds from dependencies (#231) (@jhkennedy, @danielfromearth)

Fixed

• Fix help text for second NetCDF file passed on command line (#230) (@berquist)

[1.9.0] - 2024-05-29

Changed

• Change license to Apache License 2.0. and include copyright header text (#184) (@danielfromearth)
• Change dependabot frequency to monthly (#200) (@danielfromearth)

Added

• Add gif of usage to readme (#210) (@danielfromearth)

Fixed

• Fix missing group error (#208) (@danielfromearth)
• Fix codecov upload token error (#190) (@danielfromearth)
• Resolve linting error (#199) (@danielfromearth)

[1.8.0] - 2024-03-12

Changed

• Update dependencies (#169) (@danielfromearth)
• Update citation (2178b97) (@danielfromearth)
• Update syntax for new linting checks (#168) (@danielfromearth)

[1.7.3] - 2024-02-06

Changed

• Add Zenodo badge to readme (#149) (@danielfromearth)

[1.7.2] - 2024-02-06

Changed

• Add pyOpenSci badge to readme (#148) (@danielfromearth)

[1.7.1] - 2024-02-06

Changed

• Update dependencies (#147) (@danielfromearth)
• Update citation (#147) (@danielfromearth)

[1.7.0] - 2024-02-06

Changed

• Replace data in example notebook with those requiring no credentials (#136) (@danielfromearth)

Fixed

• Fix links in readme (#135) (@danielfromearth)

[1.6.2] - 2024-01-16

Changed

• Update PyPI classifiers in pyproject.toml (#130) (@danielfromearth)

[1.6.1] - 2024-01-16

Changed

• Bump jinja2 from 3.1.2 to 3.1.3 (#125) (@danielfromearth)

Removed

• Remove unused placeholder file and .images folder (#128) (@danielfromearth)

[1.6.0] - 2024-01-16

Changed

• Improve readme in a few ways (e.g., license, badges) (#99) (@danielfromearth)
• Use ReadTheDocs instead of GitHub Pages for documentation (#106) (@danielfromearth)
• Add codecov step to tests workflow (#113) (@danielfromearth)
• Improve test coverage, especially for ncompare/core.py and ncompare/printing.py (#88) (@danielfromearth)
• Ensure examples utilize publicly accessible data (#92) (@danielfromearth)
• Disable text wrapping to properly show ncompare output in notebook example (#121) (@danielfromearth)
• Tweak wording regarding docstrings in the contributing guide (9c20671) (@danielfromearth)

Added

• Add option to only display variables and attributes that are different (#79) (@danielfromearth)
• Add version to cli (#100) (@danielfromearth)
• Add testing of ncompare with Python version 3.12 (#105) (@danielfromearth)
• Add citation file (#118) (@danielfromearth)

Removed

• Fix bug related to extra argument from command line (#124) (@danielfromearth)

Fixed

• Update out-dated example snippet in README (eaddcad) (@danielfromearth)

[1.5.0] - 2023-10-25

Added

• Add a tutorial example notebook (#63) (@danielfromearth)
• Add a simple GitHub Pages that links to an quarto-produced version of the tutorial notebook. (#64) (@danielfromearth)

[1.4.0] - 2023-10-23

Added

• Add the ability to modify the width of each column in the comparison table (#59) (@danielfromearth)

Fixed

• Remove an extra line of printed filepaths (#60) (@danielfromearth)

[1.3.0] - 2023-10-20

Fixed

• Fix variable value matching (#55) (@danielfromearth)

[1.2.0] - 2023-10-11

Changed

• Add coverage and move test running to separate workflow yml (#47) (@danielfromearth)

Added

• Add issue templates and markdown guides for CONTRIBUTING and the CODE_OF_CONDUCT (#44) (@danielfromearth)

[1.1.0] - 2023-09-26

Changed

• Update CI/CD versions, and updated README.md (#28) (@danielfromearth)

Added

• Set up dependabot for automated version updates (4b98808) (@danielfromearth)

[1.0.2] - 2023-09-20

Changed

• Use ruff and black for linting and formatting #23 (@danielfromearth)

Added

• Add automated publishing (via poetry) to TestPyPI and PyPI in Actions workflow #19 (@danielfromearth)

[1.0.1] - 2023-09-06

Changed

• Improve test suite #12 (@danielfromearth)
• Enable ncompare to work with greater group depths #13 (@danielfromearth)

Fixed

• Fix author attribute for poetry #5 (@danielfromearth)