improve read_with_dask docs, ignore OME metadata

[alessandrofelder]

Description

What is this PR

• Bug fix
• Addition of a new feature
• Other

Why is this PR needed?

• We currently read certain OME tiff files wrongly in read_with_dask, when the metadata for all tiffs is specified in a single tiff's metadata.
• read_with_dask lack return value and parameters in docs
• read_with_dask ignores .tiff files (only finds .tif files).

What does this PR do?

Ignores the OME metadata, so we can correctly read OME tiff files with dask. Also improvements to docs and ability to read .tiff files lazily, and better error handling.

References

Closes #79

How has this PR been tested?

Locally by @niksirbi and me

Is this a breaking change?

I don't think so.

Does this PR require an update to the documentation?

Docstrings updated.

Checklist:

• The code has been tested locally
• Tests have been added to cover all new functionality (unit & integration)

we would need to make, or download, suitable data to test this on. I tried but only got so far, this will be addressed separately later (ignore-ome-test branch in #99 )- so we can use read_with_dask for more urgent work. I did add a negative test for a new error that is now being raised.

• The documentation has been updated to reflect any changes
• The code has been formatted with pre-commit

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.73%. Comparing base (0d463f6) to head (f2a5f21).
Report is 6 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #98   +/-   ##
=======================================
  Coverage   92.72%   92.73%           
=======================================
  Files          37       37           
  Lines        1855     1857    +2     
=======================================
+ Hits         1720     1722    +2     
  Misses        135      135           

Flag	Coverage Δ
numba	92.67% <100.00%> (+<0.01%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[niksirbi]

Approving this without full test coverage, for the reasons you mentioned.