Skip to content

Commit

Permalink
Commit new image and update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jdavid committed Aug 28, 2023
1 parent 5e21e91 commit 4370e06
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@ supported.

# Usage from Python

The examples are not distributed with the wheel, but you can just clone the project:

git clone https://github.com/Blosc/blosc2_openhtj2k.git
cd blosc2_openhtj2k

In the examples folder there are the compress and decompress scripts, both take two
required arguments, for the input and output file:

Expand All @@ -33,10 +38,14 @@ To try out these scripts first install the required software:
pip install blosc2-openhtj2k
pip install Pillow

Then you can run the scripts, for example:
Then you can run the scripts, from the examples folder, for example:

cd examples
python compress.py kodim23.png /tmp/kodim23.b2nd
python decompress.py /tmp/kodim23.b2nd /tmp/kodim23.png

python examples/compress.py examples/teapot.ppm /tmp/teapot.b2nd
python examples/decompress.py /tmp/teapot.b2nd /tmp/teapot.png
Note that the examples cannot be run from the project's root, because it will fail to
import `blosc2_openhtj2k`, since there's a directory with that name.

For details on the arguments these commands accept call them with the `--help` option.

Expand Down
Binary file added examples/kodim23.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file removed output/.keep
Empty file.

0 comments on commit 4370e06

Please sign in to comment.