Skip to content

Commit f925fdb

Browse files
committed
docs(deps): added readme system libs instructions
1 parent c724de7 commit f925fdb

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,12 @@ codecs for use in data storage and communication applications.
1818

1919
.. image:: https://codecov.io/gh/zarr-developers/numcodecs/branch/main/graph/badge.svg
2020
:target: https://codecov.io/gh/zarr-developers/numcodecs
21+
22+
---
23+
If you already have native Blosc, Zstd, and LZ4 installed on your system and want to use these system libraries instead of the vendored sources, you
24+
should set the `NUMCODECS_USE_SYSTEM_LIBS=1` environment variable when building the wheel, like this:
25+
26+
$ NUMCODECS_USE_SYSTEM_LIBS=1 pip install numcodecs --no-binary numcodecs
27+
28+
Blosc, Zstd, and LZ4 are found via the `pkg-config` utility. Moreover, you must build all 3 `blosc`, `libzstd`, and `liblz4`
29+
components. C-Blosc comes with full sources for LZ4, LZ4HC, Snappy, Zlib and Zstd and in general, you should not worry about not having (or CMake not finding) the libraries in your system because by default the included sources will be automatically compiled and included in the C-Blosc library. This effectively means that you can be confident in having a complete support for all the codecs in all the Blosc deployments (unless you are explicitly excluding support for some of them). To compile blosc, see these [instructions](https://github.com/Blosc/c-blosc?tab=readme-ov-file#compiling-the-blosc-library).

0 commit comments

Comments
 (0)