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

README update #96

Merged
merged 6 commits into from
Jun 28, 2024
Merged

README update #96

merged 6 commits into from
Jun 28, 2024

Conversation

ziw-liu
Copy link
Collaborator

@ziw-liu ziw-liu commented Jun 27, 2024

Update README before PyPI upload:

  • Update reference
  • Fix image links using full HTTP url instead of relative
  • Update conda command since mamba is now unnecessary.

Test PyPI page: https://test.pypi.org/project/viscy/

@edyoshikun
Copy link
Contributor

edyoshikun commented Jun 27, 2024

@ziw-liu

pip install -i https://test.pypi.org/simple/ viscy
Looking in indexes: https://test.pypi.org/simple/
Collecting viscy
  Downloading https://test-files.pythonhosted.org/packages/97/9e/b01d15ce37a0605396c7967f0ceff784510d2ec2db873facd4668287ad1a/viscy-0.1.0-py3-none-any.whl.metadata (12 kB)
INFO: pip is looking at multiple versions of viscy to determine which version is compatible with other requirements. This could take a while.
ERROR: Could not find a version that satisfies the requirement iohub==0.1.0 (from viscy) (from versions: 0.1.0.dev2, 0.1.0.dev4, 0.1.0.dev5)
ERROR: No matching distribution found for iohub==0.1.0

@ziw-liu
Copy link
Collaborator Author

ziw-liu commented Jun 27, 2024

@ziw-liu

pip install -i https://test.pypi.org/simple/ viscy
Looking in indexes: https://test.pypi.org/simple/
Collecting viscy
  Downloading https://test-files.pythonhosted.org/packages/97/9e/b01d15ce37a0605396c7967f0ceff784510d2ec2db873facd4668287ad1a/viscy-0.1.0-py3-none-any.whl.metadata (12 kB)
INFO: pip is looking at multiple versions of viscy to determine which version is compatible with other requirements. This could take a while.
ERROR: Could not find a version that satisfies the requirement iohub==0.1.0 (from viscy) (from versions: 0.1.0.dev2, 0.1.0.dev4, 0.1.0.dev5)
ERROR: No matching distribution found for iohub==0.1.0

That's because iohub==0.1.0 was never uploaded to Test PyPI... Can you install from PyPI first? Actually a lot of dependencies won't be available on test PyPI.

@ziw-liu
Copy link
Collaborator Author

ziw-liu commented Jun 27, 2024

@mattersoflight adding all 3 movies will take a lot of space in README. I think links to a wiki gallery are more suited there.

@edyoshikun
Copy link
Contributor

Perhaps, it makes sense to play them either in a grid (merge the movies all in one canvas). I think a movie on the starting page is nice to have. Maybe then pick a favorite one if the prior is not possible.

@ziw-liu
Copy link
Collaborator Author

ziw-liu commented Jun 27, 2024

Perhaps, it makes sense to play them either in a grid (merge the movies all in one canvas). I think a movie on the starting page is nice to have. Maybe then pick a favorite one if the prior is not possible.

Good idea! See c49cda6

Copy link
Contributor

@edyoshikun edyoshikun left a comment

Choose a reason for hiding this comment

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

LGTM now! Thanks for the edits.

@mattersoflight
Copy link
Member

lGtm (looks Great to me!). Merging.

@mattersoflight mattersoflight merged commit dde3e27 into main Jun 28, 2024
4 checks passed
@ziw-liu ziw-liu deleted the readme-links branch June 28, 2024 15:48
edyoshikun pushed a commit that referenced this pull request Jun 29, 2024
* replace mantis preprint with QLIPP paper

* fix figure links and update conda command

* surfacing the new preprint

* added place-holders for new movies and new models

* move pipeline chart to its own page

* show video covers in a table

---------

Co-authored-by: Shalin Mehta <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants