Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adjust README #72

Merged
merged 3 commits into from
Nov 3, 2022
Merged

Adjust README #72

merged 3 commits into from
Nov 3, 2022

Conversation

pwalczysko
Copy link
Member

Tested the README workflow

Adjusted:

  • add install instructions link to napari
  • remark on the envs
  • fix a bug of the python workflow
  • remove the 0 subfolder opening routine, as it crashes atm

cc @jburel @will-moore

README.md Outdated

If a dialog in napari pops up, encouraging you to choose a reader, choose ``napari-ome-zarr`` and click OK.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could mention that you can specify the plugin on cli with napari --plugin napari-ome-zarr "https://uk1s3.embassy.ebi.ac.uk/idr/zarr/v0.3/9836842.zarr/"

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But, confusingly, when opening from S3, napari is not confused about which plugin to use.
Whereas locally, it is different, such as

napari --plugin napari-ome-zarr '6001240.zarr'

Does not produce a dialog, whereas

napari  '6001240.zarr'

Produces

Screenshot 2022-11-03 at 11 09 57

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 509461c

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know why the difference when the file is local. But you say "If a dialog in napari pops up, encouraging you to choose a reader, choose napari-ome-zarr and click OK."
If that happens, you can stop it happening with --plugin napari-ome-zarr, regardless of whether the file is local or not. So I would mention --plugin napari-ome-zarr option before mentioning local usage

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 2680af2


napari.run()

If single zarray is passed to the plugin, it will be opened without the use of
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When I tried this, I didn't need the napari.run() at least in a python terminal

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, can confirm this in python terminal. But if you leave it out in the script, then napari opens and immediately closes. With the napari.run() in the script, napari persists and is usable.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah 👍

@codecov-commenter
Copy link

codecov-commenter commented Nov 3, 2022

Codecov Report

Base: 92.43% // Head: 88.33% // Decreases project coverage by -4.09% ⚠️

Coverage data is based on head (2680af2) compared to base (d9ff37a).
Patch has no changes to coverable lines.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #72      +/-   ##
==========================================
- Coverage   92.43%   88.33%   -4.10%     
==========================================
  Files           3        2       -1     
  Lines         185      180       -5     
==========================================
- Hits          171      159      -12     
- Misses         14       21       +7     
Impacted Files Coverage Δ
napari_ome_zarr/_tests/test_reader.py 87.80% <0.00%> (-10.98%) ⬇️
napari_ome_zarr/__init__.py

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@joshmoore joshmoore merged commit e71a87f into ome:main Nov 3, 2022
@pwalczysko pwalczysko deleted the workflow branch November 3, 2022 19:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants