Skip to content

Commit

Permalink
Add notes section to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
martaiborra committed May 2, 2024
1 parent 8d4a5dd commit 54f324d
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,17 @@ cparams = {
}
```

## Notes

When using `blosc2_grok`, there are some restrictions that you have
to keep in mind.

* The minimum supported image size is around 256 bytes, so an image with
less size will fail to be compressed.
* The maximum datatype precision is of 16 bits.
* Although floats from 16 or fewer bits of precision seem to work, we
recommend using integer data when possible.

## More examples

See the [examples](examples/) directory for more examples.
Expand Down

0 comments on commit 54f324d

Please sign in to comment.