Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jwindhager committed Dec 12, 2019
1 parent 7f1656f commit 068cc2e
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,18 @@ naming of channels.

Install from pypi:

`python3 -m pip install xtiff`
`pip install xtiff`


## Usage

The package provides one single function:

```
```python3
to_tiff(img, file, image_name=None, channel_names=None, image_date=None,
write_mode=WriteMode.OME_TIFF, big_tiff=None, big_tiff_size_threshold=2 ** 32 - 2 ** 25,
byte_order=None, compression_type=None, compression_level=0, pixel_size=None, pixel_depth=None,
ome_schema_version=OMESchemaVersion.OME201606v2)
write_mode=WriteMode.OME_TIFF, big_tiff=None, big_tiff_size_threshold=4294967246,
byte_order=None, compression_type=None, compression_level=0, pixel_size=None,
pixel_depth=None, ome_schema_version=OMESchemaVersion.OME201606v2)
```

Documentation of the function parameters is available via Python's internal help system: `help(xtiff.to_tiff)`
Expand Down Expand Up @@ -53,4 +53,4 @@ minimum.

## License

This project is licensed under the [MIT license](LICENSE.txt).
This project is licensed under the [MIT license](https://github.com/BodenmillerGroup/xtiff/blob/master/LICENSE.txt).
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

setup(
name='xtiff',
version='0.1.1',
version='0.1.2',
description='A tiny Python 3 library for writing multi-channel TIFF stacks',
long_description=long_description,
long_description_content_type='text/markdown',
Expand Down

0 comments on commit 068cc2e

Please sign in to comment.