1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964
|
Release notes
=============
..
# Unindent the section between releases in order
# to document your changes. On releases it will be
# re-indented so that it does not show up in the notes.
.. _unreleased:
Unreleased
----------
.. _unreleased:
0.16.0
------
Enhancements
~~~~~~~~~~~~
* Add ``typesize`` argument to ``Blosc`` to allow for buffers that are passed to ``encode``
use that information. zarr v3 currently has its Blosc codec as bytes-to-bytes but does retain
the size information so using it here allows for massive compression ratio gains.
By :user:`Ilan Gold <ilan-gold>`
* Add support for the Linux aarch64 architecture,
By :user:`Agriya Khetarpal <agriyakhetarpal>`, :issue:`288`.
* Preallocate output buffers and resize directly as needed.
By :user:`John Kirkham <jakirkham>`, :issue:`656`
* ``Checksum32`` is now an abstract base clase, with ``checksum()`` as an abstract method.
This helps ensure that any subclasses implement the ``checksum()`` method.
:issue:`711`
Removals
~~~~~~~~
The following ``blosc`` funcitons are removed, with no replacement.
This is because they were not intended to be public API.
- ``numcodecs.blosc.init``
- ``numcodecs.blosc.destroy``
- ``numcodecs.blosc.compname_to_compcode``
- ``numcodecs.blosc.cbuffer_sizes``
- ``numcodecs.blosc.cbuffer_metainfo``
In addition, ``numcodecs.blosc.decompress_partial`` is removed as
has always been experimental and there is no equivalent in the official
blsoc Python package.
By :user:`David Stansby <dstansby>`, :issue:`712`
Maintenance
~~~~~~~~~~~
* Replace internal ``Buffer`` usage with ``memoryview``\ s.
By :user:`John Kirkham <jakirkham>`, :issue:`656`
* Bump the minimum macOS deployment target for x86_64 to 10.13.
By :user:`Agriya Khetarpal <agriyakhetarpal>`, :issue:`288`.
0.15.1
------
Improvements
~~~~~~~~~~~~
* Raise a custom `UnknownCodecError` when trying to retrieve an unavailable codec.
By :user:`Cas Wognum <cwognum>`.
Fixes
~~~~~
* Remove redundant ``id`` from codec metadata serialization in Zarr3 codecs.
By :user:`Norman Rzepka <normanrz>`, :issue:`685`
.. _release_0.15.0:
0.15.0
------
Breaking changes
~~~~~~~~~~~~~~~~
* All arguments to the ``PCodec`` constructor except for ``level``
are now keyword only, to support the updated API.
By :user:`Sam Levang <slevang>`, :issue:`623`
Deprecations
~~~~~~~~~~~~
The following ``blosc`` functions are deprecated, with no replacement.
This is because they are not intended to be public API.
- ``numcodecs.blosc.init``
- ``numcodecs.blosc.destroy``
- ``numcodecs.blosc.compname_to_compcode``
- ``numcodecs.blosc.cbuffer_sizes``
- ``numcodecs.blosc.cbuffer_metainfo``
In addition, ``numcodecs.blosc.decompress_partial`` is deprecated as
has always been experimental and there is no equivalent in the official
blsoc Python package.
By :user:`David Stansby <dstansby>`, :issue:`619`
Fixes
~~~~~
* Fixes issue with ``Delta`` Zarr 3 codec not working with ``astype``.
By :user:`Norman Rzepka <normanrz>`, :issue:`664`
* Cleanup ``PCodec`` soft dependency.
Previously importing ``numcodecs.pcodec`` would work if ``pcodec`` is not installed,
but now it will fail to import. This mirrors the behaviour of other optional dependencies.
By :user:`John Kirkham <jakirkham>`, :issue:`647`
* Fixes issues with the upcoming ``zarr`` 3.0.0 release.
By :user:`Norman Rzepka <normanrz>`, :issue:`675`
* Removed Version Check: The previous code included a check for the `NumPy` version
and a warning if the version was incompatible with `zfpy`.
This check has been removed because `zfpy` now supports the newer versions of `NumPy`.
By :user:`Meher Gajula <me-her>`, :issue:`672`
Improvements
~~~~~~~~~~~~
* Add support for ``pcodec`` 0.3. This exposes the new ``delta_spec``
and ``paging_spec`` arguments, but maintains full backwards
compatibility for data written with older package versions.
By :user:`Sam Levang <slevang>`, :issue:`623`
* If an import error is raised when trying to define a codec that is *not*
an optional dependency, it is no longer silently caught. Instead it will
be propagated to the user, as this indicates an issue with the installed
package.
Import errors caused by optional dependencies (ZFPY, MsgPack, CRC32C, and PCodec)
are still silently caught.
By :user:`David Stansby <dstansby>`, :issue:`550`.
.. _release_0.14.1:
0.14.1
------
Fixes
~~~~~
* Cleanups to the ``crc32c`` soft dependency.
Whereas in ``numcodecs`` 0.14.0 a runtime error was raised if
the ``CRC32C`` codec used without the ``crc32c`` installed,
the ``CRC32C`` codec is no longer defined at import time if
``crc32c`` is not installed. This has been changed to match
the behaviour of other optional dependencies/codecs.
By :user:`John Kirkham <jakirkham>`, :issue:`637`
Improvements
~~~~~~~~~~~~
* Add `noexcept` to `_utils` C-equiv functions
By :user:`John Kirkham <jakirkham>`, :issue:`641`.
.. _release_0.14.0:
0.14.0
------
Enhancements
~~~~~~~~~~~~
* Add Crc32c checksum codec.
By :user:`Norman Rzepka <normanrz>`, :issue:`613`.
* Add codec wrappers for Zarr 3.
By :user:`Norman Rzepka <normanrz>`, :issue:`524`
* Added mypy type checking to continuous integration.
By :user:`David Stansby <dstansby>`, :issue:`460`.
Fixes
~~~~~
* Fix in-place mutation of input array in `BitRound`.
By :user:`Sam Levang <slevang>`, :issue:`608`
* Fix an issue where importing numcodecs would lock the state of `multiprocessing`
and prevent user code to call `multiprocessing.set_start_method("spawn")`
subsequently.
By :user:`Clément Robert <neutrinoceros>` :issue:`522`
Maintenance
~~~~~~~~~~~
* The minimum supported Python version is now Python 3.11.
By :user:`David Stansby <dstansby>`, :issue:`622`
* The minimum supported numpy version is now 1.24.
By :user:`David Stansby <dstansby>`, :issue:`622`
.. _release_0.13.1:
0.13.1
------
Breaking changes
~~~~~~~~~~~~~~~~
* `Zstd.default_level`, `Zstd.min_level`, and `Zstd.max_level` are now class methods
instead of properties. This means they must now be called like ``Zstd.default_level()``
instead of ``Zstd.default_level``. This breaking change has been made because Python 3.13
removes support for class properties.
By :user:`David Stansby <dstansby>`, :issue:`576`.
Enhancements
~~~~~~~~~~~~
* Update bundled c-blosc to v1.26.1. This updates Zlib to v1.3.1
and Zstd to v1.5.6.
By :user:`David Stansby <dstansby>`, :issue:`560`.
* Added support for Python 3.13 :user:`David Stansby <dstansby>`, :issue:`576`.
* Cleaned up the table of contents in the documentation to list codecs by category
:user:`David Stansby <dstansby>`, :issue:`458`.
Maintenance
~~~~~~~~~~~
* Change format() and old string formatting to f-strings.
By :user:`Dimitri Papadopoulos Orfanos <DimitriPapadopoulos>`, :issue:`439`.
* Remove pin on Sphinx
By :user:`Elliott Sales de Andrade <QuLogic>`, :issue:`552`.
.. _release_0.13.0:
0.13.0
------
Enhancements
~~~~~~~~~~~~
* Add checksum flag to zstd and sets the default level to 0.
By :user:`Norman Rzepka <normanrz>`, :issue:`519`.
* Add PCodec
By :user:`Ryan Abernathey <rabernat>`, :issue:`501`.
* Use PyData theme for docs
By :user:`John Kirkham <jakirkham>`, :issue:`485`.
* Improve the structure of docs
By :user:`David Stansby <dstansby>`, :issue:`458`.
Fix
~~~
* Fix VLenUTF8 encoding for read-only buffers.
By :user:`Isaac Virshup <ivirshup>`, :issue:`514`.
* Fix skip of entry points backport tests
By :user:`Elliott Sales de Andrade <QuLogic>`, :issue:`487`.
* Fix Upgrade to Zstd 1.5.5 due to potential corruption.
By :user:`Mark Kittisopikul <mkitti>`, :issue:`429`
* Add version constraint(<2.0) for numpy in zfpy.
By :user:`Tom Liang <px39n>`, :issue:`540`.
Maintenance
~~~~~~~~~~~
* The minimum supported Python version is now Python 3.10.
By :user:`David Stansby <dstansby>`, :issue:`531`
* Add numpy 2 compatibility.
By :user:`David Stansby <dstansby>`, :issue:`535`
* Update c-blosc to 1.21.0 to 1.21.5, zstd from 1.4.8 to 1.5.5,
lz4 from 1.9.3 to 1.9.4, and zlib from 1.2.8 to to 1.2.13
By :user:`Mark Kittisopikul <mkitti>`, :issue:`500`
.. _release_0.12.1:
0.12.1
------
Fix
~~~
* ``Codec`` is now derived from ``abc.ABC``
By :user:`Mads R. B. Kristensen <madsbk>`, :issue:`472`.
* Fix handling of entry points on older Python versions where ``importlib_metadata`` compatibility is concerned
By :user:`Vyas Ramasubramani <vyasr>`, :issue:`478`.
* Make shuffle pyx functions ``noexcept``
By :user:`Martin Durant <martindurant>`, :issue:`477`.
.. _release_0.12.0:
0.12.0
------
Enhancements
~~~~~~~~~~~~
* Add ``fletcher32`` checksum codec
By :user:`Martin Durant <martindurant>`, :issue:`410`.
* Add ``jenkins_lookup3`` checksum codec
By :user:`Mark Kittisopkul <mkitti>`, :issue:`445`.
* Support Python 3.12.
By :user:`John Kirkham <jakirkham>`, :issue:`471`.
Fix
~~~
* Fixed docs/Makefile error message when sphinx is not present
By :user:`Mark Kittisopikul <mkitti>`, :issue:`451`.
* Add missing RTD requirements
By :user:`John Kirkham <jakirkham>`, :issue:`455`.
Maintenance
~~~~~~~~~~~
* Cleanup ``import``\ s in ``adhoc/blosc_memleak_check.py``
By :user:`John Kirkham <jakirkham>`, :issue:`408`.
.. _release_0.11.0:
0.11.0
------
Fix
~~~
* Speed up isinstance checks of :class:`numcodecs.ndarray_like.NDArrayLike`,
:class:`numcodecs.ndarray_like.DType` and :class:`numcodecs.ndarray_like.FlagsObj`.
By :user:`Andreas Poehlmann <ap-->`, :issue:`379`.
Maintenance
~~~~~~~~~~~
* Remove unnecessary None argument to .get(), it is the default value.
By :user:`Dimitri Papadopoulos Orfanos <DimitriPapadopoulos>`, :issue:`395`.
* Apply refurb suggestions.
By :user:`Dimitri Papadopoulos Orfanos <DimitriPapadopoulos>`, :issue:`372`.
* Migrate codespell configuration to pyproject.toml and get rid of setup.cfg.
By :user:`Dimitri Papadopoulos Orfanos <DimitriPapadopoulos>` :issue:`374`.
* Unvendor cpuinfo.
By :user:`Dimitri Papadopoulos Orfanos <DimitriPapadopoulos>` :issue:`373`.
* Drop headers.
By :user:`John Kirkham <jakirkham>`, :issue:`375`.
* Remove Python 2 code.
By :user:`Dimitri Papadopoulos Orfanos <DimitriPapadopoulos>` :issue:`368`,
:issue:`387`.
* Support Python 3.11.
By :user:`Dimitri Papadopoulos Orfanos <DimitriPapadopoulos>`, :issue:`369`.
* Drop Python 3.7.
By :user:`John Kirkham <jakirkham>`,, :issue:`405` :issue:`406`.
* Test with zfpy 1.0.0.
By :user:`John Kirkham <jakirkham>`, :issue:`385`.
* Remove vendored C files and re-generate them on the fly using Cython.
Add a pyproject.toml file to define Cython as a build dependency.
By :user:`Dimitri Papadopoulos Orfanos <DimitriPapadopoulos>`, :issue:`369`.
* Update cpuinfo to 9.0.0.
By :user:`Dimitri Papadopoulos Orfanos <DimitriPapadopoulos>` :issue:`370`.
* Add tests for all registry classes.
By :user:`Josh Moore <joshmoore>`, :issue:`349`.
* Add workflow to label PRs with "needs release notes".
By :user:`Saransh Chopra <Saransh-cpp>` :issue:`396`.
* Finish ``pyproject.toml`` migration.
By :user:`John Kirkham <jakirkham>` :issue:`382`.
* Drop tox.
By :user:`John Kirkham <jakirkham>`, :issue:`384`.
* Update ReadTheDocs.
By :user:`John Kirkham <jakirkham>`, :issue:`383`.
* Use `conda-incubator/setup-miniconda@v2.2.0` (and use Conda on Linux).
By :user:`John Kirkham <jakirkham>` :issue:`398`.
* Bring coverage back up to 100%.
By :user:`John Kirkham <jakirkham>` and :user:`Martin Durant <martindurant>`,
:issue:`392` and :issue:`393`.
* Collect coverage on all OSes & enable Codecov.
By :user:`John Kirkham <jakirkham>`, :issue:`386`, :issue:`388`,
:issue:`390`, :issue:`391`.
.. _release_0.10.2:
0.10.2
------
Fix
~~~
* Add BitRound (0.10.0) to registry.
By :user:`Josh Moore <joshmoore>`, :issue:`342`.
.. _release_0.10.1:
0.10.1
------
Maintenance
~~~~~~~~~~~
* Add entrypoints to setup.py.
By :user:`Josh Moore <joshmoore>`, :issue:`332`.
* Fix spelling.
By :user:`Dimitri Papadopoulos Orfanos <DimitriPapadopoulos>`, :issue:`336`.
* Drop Python 3.6 from tests
By :user:`Dimitri Papadopoulos Orfanos <DimitriPapadopoulos>`,
:issue:`338`, :issue:`339`.
* Remove trailing spaces and empty lines.
By :user:`Dimitri Papadopoulos Orfanos <DimitriPapadopoulos>`, :issue:`341`.
* Add LGTM.com configuration file
By :user:`Dimitri Papadopoulos Orfanos <DimitriPapadopoulos>`, :issue:`337`.
.. _release_0.10.0:
0.10.0
------
Enhancements
~~~~~~~~~~~~
* Add support of alternative array classes (other than NumPy arrays)
By :user:`Mads R. B. Kristensen <madsbk>`, :issue:`305`.
* Add ability to find codecs via entrypoint `numcodecs.codecs`.
By :user:`Martin Durant <martindurant>`, :issue:`290`.
* Add bitround codec
By :user:`Ryan Abernathy <rabernat>` and :user:`Martin Durant <martindurant>`, :issue:`298`.
* Introduce a flat option to ensure_contiguous_ndarray to switch off flatten for ZFPY codec
By :user:`Haiying Xu <halehawk>`, :issue:`307`.
Bug fixes
~~~~~~~~~
* Fix a flatten array error for ZFPY, ZFPY codec is supported on Python 3.9
and 3.10 on Linux and MacOS, the docs about ZFPY is also available.
By :user:`Haiying Xu <halehawk>`, :user:`John Kirkham <jakirkham>`,
:user:`Ryan Abernathey <rabernat>` :issue:`303`.
* Codex: make encode and decode @abstractmethods
By :user:`Mads R. B. Kristensen <madsbk>`, :issue:`306`.
* Fix expected result test for Shuffle.
By :user:`Elliott Sales de Andrade <QuLogic>`, :issue:`282`.
Maintenance
~~~~~~~~~~~
* Multiple code linting fixes.
By :user:`Dimitri Papadopoulos Orfanos <DimitriPapadopoulos>`,
:issue:`295`, :issue:`294`, :issue:`293`, and :issue:`292`.
* Drop Python 3.6
By :user:`Josh Moore <joshmoore>`, :issue:`318`.
* Fix macOS Python 3.10
By :user:`John Kirkham <jakirkham>`, :issue:`311`.
* chore: bump cibuildwheel version, use action
By :user:`Henry Schreiner <henryiii>`, :issue:`309`.
* Specify `language` as `'en'` instead of `None`.
By :user:`John Kirkham <jakirkham>`, :issue:`329`.
* Move `master` to `main`.
By :user:`John Kirkham <jakirkham>`, :issue:`322`.
* Drop `fastparquet` benchmark.
By :user:`John Kirkham <jakirkham>`, :issue:`321`.
* Trim wheel builds.
By :user:`John Kirkham <jakirkham>`, :issue:`320`.
.. _release_0.9.1:
0.9.1
-----
* Fix inaccurate docstrings for Blosc.
By :user:`James Webber <jamestwebber>`, :issue:`287`.
.. _release_0.9.0:
0.9.0
-----
* c-blosc upgrade 1.18.1 -> 1.21.0.
Warning: this temporarily removes support for snappy compression!
By :user:`kindjacket <kindjacket>`, :issue:`283`.
* Fix an ImportError with Blosc on Android.
By :user:`Daniel Jewell <danieldjewell>`, :issue:`284`.
.. _release_0.8.1:
0.8.1
-----
* Fix an ImportError with Blosc on Android.
By :user:`Daniel Jewell <danieldjewell>`, :issue:`284`.
.. _release_0.8.0:
0.8.0
-----
* The :class:`numcodecs.zfpy.ZFPY` codec is now supported on Python 3.8 if
`zfpy==0.5.5 <https://pypi.org/project/zfpy/>`_ is installed.
By :user:`haiying xu <halehawk>`, :issue:`229`.
* Add support for byte Shuffle filter
By :user:`Paul Branson <pbranson>` and :user:`Martin Durant <martindurant>` :issue:`273`.
* Update Windows + Mac CI to run all tests.
By :user:`Jackson Maxfield Brown <JacksonMaxfield>`, :issue:`276`.
Help from :user:`Oleg Höfling <hoefling>`, :issue:`273`.
* Update cpuinfo to 8.0.0.
By :user:`Florian Jetter <fjetter>`, :issue:`280`.
* Drop out-of-date manual release docs.
By :user:`John Kirkham <jakirkham>`, :issue:`272`.
* Add support for Python 3.9 and Update GitHub Actions.
.. _release_0.7.3:
0.7.3
-----
* Add support for Python 3.9 and Update GitHub Actions.
By :user:`Jackson Maxfield Brown <JacksonMaxfield>`, :issue:`270`.
* Remove support for Python 3.5 which is end of life. While the code base might
still be compatible; the source dist and wheel are marked as Python 3.6+ and
pip will not install them. Continuous integration on Python 3.5 has been
disabled.
By :user:`Matthias Bussonnier <Carreau>`, :issue:`266` and :issue:`267`.
.. _release_0.7.2:
0.7.2
-----
* Disable avx2 for wheel.
By :user:`Grzegorz Bokota <Czaki>`, :issue:`253`.
* Add Base64 fixtures.
By :user:`John Kirkham <jakirkham>`, :issue:`251`.
* Update docs regarding wheels.
By :user:`Josh Moore <joshmoore>`, :issue:`250`.
.. _release_0.7.1:
0.7.1
-----
* Fix build of wheels.
By :user:`Grzegorz Bokota <Czaki>`, :issue:`244`.
.. _release_0.7.0:
0.7.0
-----
* Automatically release to PyPI.
By :user:`Josh Moore <joshmoore>`, :issue:`241`.
* Build wheels on github actions.
By :user:`Grzegorz Bokota <Czaki>`, :issue:`224`.
* Add Base64 codec.
By :user:`Trevor Manz <manzt>`, :issue:`176`.
* Add partial decompression of Blosc compressed arrays.
By :user:`Andrew Fulton <andrewfulton9>`, :issue:`235`.
* Remove LegacyJSON codec.
By :user:`James Bourbeau <jrbourbeau>`, :issue:`226`.
* Remove LegacyMsgPack codec.
By :user:`James Bourbeau <jrbourbeau>`, :issue:`218`.
* Drop support for Python 2.
By :user:`James Bourbeau <jrbourbeau>`, :issue:`220`.
.. _release_0.6.4:
0.6.4
-----
* Update Cython to 0.29.14.
By :user:`John Kirkham <jakirkham>`, :issue:`168`, :issue:`177`, :issue:`204`.
* The bundled c-blosc sources have been upgraded to version 1.17.0.
This fixes compilation with newer versions of gcc.
By :user:`Joe Jevnik <llllllllll>`, :issue:`194`.
* Create ``.pep8speaks.yml``. By :user:`Alistair Miles <alimanfoo>`.
* Simplify datetime/timedelta check.
By :user:`John Kirkham <jakirkham>`, :issue:`170`, :issue:`171`.
* Update URL metadata for PyPI.
By :user:`Elliott Sales de Andrade <QuLogic>`, :issue:`178`.
* Enable pytest rewriting in test helper functions.
By :user:`Elliott Sales de Andrade <QuLogic>`, :issue:`185`.
* Rewrites the ``ensure_text`` implementation.
By :user:`John Kirkham <jakirkham>`, :issue:`201`, :issue:`205`, :issue:`206`.
* Add macOS to CI.
By :user:`Alistair Miles <alimanfoo>`, :issue:`192`.
* Fix test failures on big-endian systems.
By :user:`Elliott Sales de Andrade <QuLogic>`, :issue:`186`.
* Use unittest.mock on Python 3.
By :user:`Elliott Sales de Andrade <QuLogic>`, :issue:`179`.
* Don't mask compile errors in setup.py.
By :user:`Joe Jevnik <llllllllll>`, :issue:`197`.
* Allow pickles when loading test fixture data.
By :user:`Elliott Sales de Andrade <QuLogic>`, :issue:`193`.
* Update ``cpuinfo.py``.
By :user:`John Kirkham <jakirkham>`, :issue:`202`.
* Use ``ensure_text`` in JSON codecs.
By :user:`John Kirkham <jakirkham>`, :issue:`207`.
* Support Python 3.8.
By :user:`John Kirkham <jakirkham>`, :issue:`208`.
.. _release_0.6.3:
0.6.3
-----
* Drop support for 32-bit Windows.
By :user:`Alistair Miles <alimanfoo>`, :issue:`97`, :issue:`156`.
* Raise a ``TypeError`` if an ``object`` array is passed to ``ensure_bytes``.
By :user:`John Kirkham <jakirkham>`, :issue:`162`.
* Update Cython to 0.29.3.
By :user:`John Kirkham <jakirkham>`, :issue:`165`.
.. _release_0.6.2:
0.6.2
-----
* Handle (new) buffer protocol conforming types in ``Pickle.decode``.
By :user:`John Kirkham <jakirkham>`, :issue:`143`, :issue:`150`.
* Use (new) buffer protocol in ``MsgPack`` codec `decode()` method.
By :user:`John Kirkham <jakirkham>`, :issue:`148`.
* Use (new) buffer protocol in ``JSON`` codec `decode()` method.
By :user:`John Kirkham <jakirkham>`, :issue:`151`.
* Avoid copying into data in ``GZip``'s `decode()` method on Python 2.
By :user:`John Kirkham <jakirkham>`, :issue:`152`.
* Revert ndarray coercion of encode returned data.
By :user:`John Kirkham <jakirkham>`, :issue:`155`.
* The bundled c-blosc sources have been upgraded to version 1.15.0. By
:user:`Alistair Miles <alimanfoo>` and :user:`John Kirkham <jakirkham>`, :issue:`142`, :issue:`145`.
.. _release_0.6.1:
0.6.1
-----
* Resolved minor issue in backwards-compatibility tests (by :user:`Alistair Miles
<alimanfoo>`, :issue:`138`, :issue:`139`).
.. _release_0.6.0:
0.6.0
-----
* The encoding format used by the :class:`JSON` and :class:`MsgPack` codecs has been
changed to resolve an issue with correctly encoding and decoding some object arrays.
Now the encoded data includes the original shape of the array, which enables the
correct shape to be restored on decoding. The previous encoding format is still
supported, so that any data encoded using a previous version of numcodecs can still be
read. Thus no changes to user code and applications should be required, other
than upgrading numcodecs. By :user:`Jerome Kelleher <jeromekelleher>`; :issue:`74`,
:issue:`75`.
* Updated the msgpack dependency (by :user:`Jerome Kelleher <jeromekelleher>`;
:issue:`74`, :issue:`75`).
* Added support for ppc64le architecture by updating `cpuinfo.py` from upstream (by
:user:`Anand S <anandtrex>`; :issue:`82`).
* Allow :class:`numcodecs.blosc.Blosc` compressor to run on systems where locks are not present (by
:user:`Marcus Kinsella <mckinsel>`, :issue:`83`; and :user:`Tom White <tomwhite>`,
:issue:`93`).
* Drop Python 3.4 (by :user:`John Kirkham <jakirkham>`; :issue:`89`).
* Add Python 3.7 (by :user:`John Kirkham <jakirkham>`; :issue:`92`).
* Add codec :class:`numcodecs.gzip.GZip` to replace ``gzip`` alias for ``zlib``,
which was incorrect (by :user:`Jan Funke <funkey>`; :issue:`87`; and :user:`John Kirkham <jakirkham>`, :issue:`134`).
* Corrects handling of ``NaT`` in ``datetime64`` and ``timedelta64`` in various
compressors (by :user:`John Kirkham <jakirkham>`; :issue:`127`, :issue:`131`).
* Improvements to the compatibility layer used for normalising inputs to encode
and decode methods in most codecs. This removes unnecessary memory copies for
some codecs, and also simplifies the implementation of some codecs, improving
code readability and maintainability. By :user:`John Kirkham <jakirkham>` and
:user:`Alistair Miles <alimanfoo>`; :issue:`119`, :issue:`121`, :issue:`128`.
* Return values from encode() and decode() methods are now returned as numpy
arrays for consistency across codecs. By :user:`John Kirkham <jakirkham>`,
:issue:`136`.
* Improvements to handling of errors in the :class:`numcodecs.blosc.Blosc` and
:class:`numcodecs.lz4.LZ4` codecs when the maximum allowed size of an input
buffer is exceeded. By :user:`Jerome Kelleher <jeromekelleher>`, :issue:`80`,
:issue:`81`.
.. _release_0.5.5:
0.5.5
-----
* The bundled c-blosc sources have been upgraded to version 1.14.3 (:issue:`72`).
.. _release_0.5.4:
0.5.4
-----
* The bundled c-blosc sources have been upgraded to version 1.14.0 (:issue:`71`).
.. _release_0.5.3:
0.5.3
-----
* The test suite has been migrated to use pytest instead of nosetests
(:issue:`61`, :issue:`62`).
* The bundled c-blosc library has been updated to version 1.13.4 (:issue:`63`,
:issue:`64`).
.. _release_0.5.2:
0.5.2
-----
* Add support for encoding None values in VLen... codecs (:issue:`59`).
.. _release_0.5.1:
0.5.1
-----
* Fixed a compatibility issue with the Zlib codec to ensure it can handle
bytearray objects under Python 2.7 (:issue:`57`).
* Restricted the :class:`numcodecs.categorize.Categorize` codec to object
('O') and unicode ('U') dtypes and disallowed bytes ('S') dtypes because
these do not round-trip through JSON configuration.
.. _release_0.5.0:
0.5.0
-----
* Added new codecs for encoding arrays with variable-length unicode strings
(:class:`numcodecs.vlen.VLenUTF8`), variable-length byte strings
(:class:`numcodecs.vlen.VLenBytes`) and variable-length numerical arrays
((:class:`numcodecs.vlen.VLenArray`) (:issue:`56`).
.. _release_0.4.1:
0.4.1
-----
* Resolved an issue where providing an array with dtype ``object`` as the destination
when decoding could cause segfaults with some codecs (:issue:`55`).
.. _release_0.4.0:
0.4.0
-----
* Added a new :class:`numcodecs.json.JSON` codec as an alternative for encoding of
object arrays (:issue:`54`).
.. _release_0.3.1:
0.3.1
-----
* Revert the default shuffle argument to SHUFFLE (byte shuffle) for the
:class:`numcodecs.blosc.Blosc` codec for compatibility and consistency with previous
code.
.. _release_0.3.0:
0.3.0
-----
* The :class:`numcodecs.blosc.Blosc` codec has been made robust for usage in both
multithreading and multiprocessing programs, regardless of whether Blosc has been
configured to use multiple threads internally or not (:issue:`41`, :issue:`42`).
* The :class:`numcodecs.blosc.Blosc` codec now supports an ``AUTOSHUFFLE`` argument
when encoding (compressing) which activates bit- or byte-shuffle depending on the
itemsize of the incoming buffer (:issue:`37`, :issue:`42`). This is also now the
default.
* The :class:`numcodecs.blosc.Blosc` codec now raises an exception when an invalid
compressor name is provided under all circumstances (:issue:`40`, :issue:`42`).
* The bundled version of the c-blosc library has been upgraded to version 1.12.1
(:issue:`45`, :issue:`42`).
* An improvement has been made to the system detection capabilities during compilation
of C extensions (by :user:`Prakhar Goel <newt0311>`; :issue:`36`, :issue:`38`).
* Arrays with datetime64 or timedelta64 can now be passed directly to compressor codecs
(:issue:`39`, :issue:`46`).
.. _release_0.2.1:
0.2.1
-----
The bundled c-blosc library has been upgraded to version 1.11.3 (:issue:`34`, :issue:`35`).
.. _release_0.2.0:
0.2.0
-----
New codecs:
* The :class:`numcodecs.quantize.Quantize` codec, which provides support for reducing the precision
of floating-point data, has been ported over from Zarr (:issue:`28`, :issue:`31`).
Other changes:
* The :class:`numcodecs.zlib.Zlib` codec is now also registered under the alias 'gzip'
(:issue:`29`, :issue:`32`).
Maintenance work:
* A data fixture has been added to the test suite to add some protection against changes to codecs
that break backwards-compatibility with data encoded using a previous release of numcodecs
(:issue:`30`, :issue:`33`).
.. _release_0.1.1:
0.1.1
-----
This release includes a small modification to the setup.py script to provide greater control over
how compiler options for different instruction sets are configured (:issue:`24`,
:issue:`27`).
.. _release_0.1.0:
0.1.0
-----
New codecs:
* Two new compressor codecs :class:`numcodecs.zstd.Zstd` and :class:`numcodecs.lz4.LZ4`
have been added (:issue:`3`, :issue:`22`). These provide direct support for
compression/decompression using `Zstandard <https://github.com/facebook/zstd>`_ and
`LZ4 <https://github.com/lz4/lz4>`_ respectively.
* A new :class:`numcodecs.msgpacks.MsgPack` codec has been added which uses
`msgpack-python <https://github.com/msgpack/msgpack-python>`_ to perform encoding/decoding,
including support for arrays of Python objects
(`Jeff Reback <https://github.com/jreback>`_; :issue:`5`, :issue:`6`, :issue:`8`,
:issue:`21`).
* A new :class:`numcodecs.pickles.Pickle` codec has been added which uses the Python pickle protocol
to perform encoding/decoding, including support for arrays of Python objects
(`Jeff Reback <https://github.com/jreback>`_; :issue:`5`, :issue:`6`, :issue:`21`).
* A new :class:`numcodecs.astype.AsType` codec has been added which uses NumPy to perform type
conversion (`John Kirkham <https://github.com/jakirkham>`_; :issue:`7`, :issue:`12`,
:issue:`14`).
Other new features:
* The :class:`numcodecs.lzma.LZMA` codec is now supported on Python 2.7 if
`backports.lzma <https://pypi.python.org/pypi/backports.lzma>`_ is installed
(`John Kirkham <https://github.com/jakirkham>`_; :issue:`11`, :issue:`13`).
* The bundled c-blosc library has been upgraded to version
`1.11.2 <https://github.com/Blosc/c-blosc/releases/tag/v1.11.2>`_ (:issue:`10`,
:issue:`18`).
* An option has been added to the :class:`numcodecs.blosc.Blosc` codec to allow the block size to
be manually configured (:issue:`9`, :issue:`19`).
* The representation string for the :class:`numcodecs.blosc.Blosc` codec has been tweaked to
help with understanding the shuffle option (:issue:`4`, :issue:`19`).
* Options have been added to manually control how the C extensions are built regardless of the
architecture of the system on which the build is run. To disable support for AVX2 set the
environment variable "DISABLE_NUMCODECS_AVX2". To disable support for SSE2 set the environment
variable "DISABLE_NUMCODECS_SSE2". To disable C extensions altogether set the environment variable
"DISABLE_NUMCODECS_CEXT" (:issue:`24`, :issue:`26`).
Maintenance work:
* CI tests now run under Python 3.6 as well as 2.7, 3.4, 3.5 (:issue:`16`, :issue:`17`).
* Test coverage is now monitored via
`coveralls <https://coveralls.io/github/alimanfoo/numcodecs?branch=master>`_
(:issue:`15`, :issue:`20`).
.. _release_0.0.1:
0.0.1
-----
Fixed project description in setup.py.
.. _release_0.0.0:
0.0.0
-----
First release. This version is a port of the ``codecs`` module from `Zarr
<https://zarr.readthedocs.io>`_ 2.1.0. The following changes have been made from
the original Zarr module:
* Codec classes have been re-organized into separate modules, mostly one per
codec class, for ease of maintenance.
* Two new codec classes have been added based on 32-bit checksums:
:class:`numcodecs.checksum32.CRC32` and :class:`numcodecs.checksum32.Adler32`.
* The Blosc extension has been refactored to remove code duplications related
to handling of buffer compatibility.
|