https://github.com/juntyr/numcodecs-rs
numcodecs Rust API for buffer compression
https://github.com/juntyr/numcodecs-rs
compression encoding numcodecs
Last synced: about 1 year ago
JSON representation
numcodecs Rust API for buffer compression
- Host: GitHub
- URL: https://github.com/juntyr/numcodecs-rs
- Owner: juntyr
- License: mpl-2.0
- Created: 2024-07-19T06:38:24.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-13T12:07:54.000Z (over 1 year ago)
- Last Synced: 2025-03-18T09:21:40.279Z (about 1 year ago)
- Topics: compression, encoding, numcodecs
- Language: Rust
- Homepage: https://juntyr.github.io/numcodecs-rs/
- Size: 8.03 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![CI Status]][workflow] [![MSRV]][repo] [![Latest Version]][crates.io] [![Rust Doc Main]][docs]
[CI Status]: https://img.shields.io/github/actions/workflow/status/juntyr/numcodecs-rs/ci.yml?branch=main
[workflow]: https://github.com/juntyr/numcodecs-rs/actions/workflows/ci.yml?query=branch%3Amain
[MSRV]: https://img.shields.io/badge/MSRV-1.82.0-blue
[repo]: https://github.com/juntyr/numcodecs-rs
[Latest Version]: https://img.shields.io/crates/v/numcodecs
[crates.io]: https://crates.io/search?q=numcodecs
[Rust Doc Main]: https://img.shields.io/badge/docs-main-blue
[docs]: https://juntyr.github.io/numcodecs-rs
# numcodecs-rs
This repository provides a compression codec API in Rust inspired by the [`numcodecs`] Python API.
The repository is structured as follows:
- [`crates`](crates): Fundamental compression API crates
- [`numcodecs`](crates/numcodecs): Rusty compression codec API
- [`numcodecs-python`](crates/numcodecs-python): Rust bindings to the [`numcodecs`] Python API, which allows Python codecs to be used in Rust and Rust codecs to be used in Python
- [`numcodecs-wasm-builder`](crates/numcodecs-wasm-builder): Compile a Rust codec into a WebAssembly [component] using `numcodecs-wasm-guest`
- [`numcodecs-wasm-guest`](crates/numcodecs-wasm-guest): Export a Rust codec as a WebAssembly [component] when compiling to WebAssembly
- [`numcodecs-wasm-host`](crates/numcodecs-wasm-host): Import a codec from a WebAssembly [component]
- [`numcodecs-wasm-host-reproducible`](crates/numcodecs-wasm-host-reproducible): Import a [`DynCodec`] from a WASM [component] inside a reproducible and fully sandboxed WebAssembly runtime
- [`numcodecs-wasm-logging`](crates/numcodecs-wasm-logging/): A codec wrapper that enables logging when compiled to WebAssembly
- [`codecs`](codecs): Codec implementation crates, some new, some adapting existing [`numcodecs`] codecs with a more composable API
- [`py`](py): Python packages that expose the compression codecs
- [`numcodecs-wasm`](py/numcodecs-wasm/): Load a WebAssembly [component] into a Python class implementing the [`numcodecs`] Python API
- [`numcodecs-wasm-materialize`](py/numcodecs-wasm-materialize/): Build Python packages for the codecs implemented in this repository by compiling them to WebAssembly [component]s using the `numcodecs-wasm-builder` and creating packages using the `numcodecs-wasm-template`
- [`numcodecs-wasm-template`](py/numcodecs-wasm-template/): Template for a Python package that exports a WebAssembly [component] as a Python class implementing the [`numcodecs`] Python API
[`numcodecs`]: https://numcodecs.readthedocs.io/en/stable/
[component]: https://component-model.bytecodealliance.org/design/components.html
[`DynCodec`]: https://docs.rs/numcodecs/latest/numcodecs/trait.DynCodec.html
## License
Licensed under the Mozilla Public License, Version 2.0 ([LICENSE](LICENSE) or https://www.mozilla.org/en-US/MPL/2.0/).
## Funding
The `numcodecs-rs` repository has been developed as part of [ESiWACE3](https://www.esiwace.eu), the third phase of the Centre of Excellence in Simulation of Weather and Climate in Europe.
Funded by the European Union. This work has received funding from the European High Performance Computing Joint Undertaking (JU) under grant agreement No 101093054.