search

ome / ZarrReader

Other
6 stars 9 forks source link

Update ReadMe and Change Log #73

Closed dgault closed 4 months ago

dgault commented 10 months ago

I have updated the ReadMe to remove the outdated TODO section and add documentation for the new reader options. I have also added a link to the release on artifactory

The change log has also been updated to included missing entries from previous releases

Fixes #72

will-moore commented 10 months ago

I remember it was mentioned that we should highlight the one change in behaviour that users might notice: labels are not now considered as separate images. I guess this maybe falls into docs rather than changelog (along with the new bfoptions documentation)?

dgault commented 10 months ago

Yeah, that is a good point. I have added some additional description for that particular setting to note the change in behaviour

will-moore commented 9 months ago

Am I right in thinking that the way ZarrReader looks for .bfoptions is different from other readers? ZarrReader looks for file.zarr.bfoptions as a sibling beside the file.zarr directory, whereas other readers look for e.g. file.tiff.bfoptions beside the file that is passed to setId. I don't know if that distinction should be made in this repo docs or at https://bio-formats.readthedocs.io/en/latest/formats/options.html#usage

Looking at that page, I don't see that either of these methods is mentioned for specifying bfoptions?

dgault commented 9 months ago

Yeah, that is a good point, I will update the readme to include some details on the bfoptions file usage