Skip to content

Instructions to install from pip and github #451

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

Merged
merged 2 commits into from
Jul 10, 2025
Merged

Conversation

talonchandler
Copy link
Collaborator

pip install waveorder installs the latest stable release from PyPI, which is often incompatible with the latest changes in the GitHub README.

This change clarifies two major ways to install: (1) from PyPI, and (2) from Github for running examples.

@talonchandler talonchandler marked this pull request as ready for review May 21, 2025 20:47
@mattersoflight
Copy link
Member

@talonchandler in addition to above, please account for the discussion of switching over to iohub 0.2.0. I will also relay the discussion with @tayllatheodoro soon around how waveorder and biahub can operate better. Let's handle installation instructions and dependencies in this PR. The code for interoperability can be a quick follow up.

@talonchandler
Copy link
Collaborator Author

please account for the discussion of switching over to iohub 0.2.0

I might be missing context here, but waveorder's main branch now depends on iohub>=0.2,<0.3 (thanks @ziw-liu for this fix #448).

@mattersoflight
Copy link
Member

mattersoflight commented May 25, 2025

@talonchandler

I might be missing context here.
As I mentioned, https://github.com/czbiohub-sf/mantis-analysis-template still uses recOrder. @tayllatheodoro needs guidance on how to switch over to the new waveOrder.

I will also relay the discussion with @tayllatheodoro soon around how waveorder and biahub can operate better.

A good structure is that the waveOrder calls are wrapped in biahub's API and used in mantis-analysis-pipeline, ops-analysis-pipeline etc. This PR could pair well with the other PR you and Alex have started (czbiohub-sf/biahub#94). What do you think? We can discuss this on an issue on biahub.

After you merge AQLM demos and this README, please switch biahub's reconstruction CLI over to use waveorder.

mattersoflight
mattersoflight previously approved these changes May 25, 2025
Copy link
Member

@mattersoflight mattersoflight left a comment

Choose a reason for hiding this comment

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

I think clear and accurate guidance on how to setup conda environment to run examples is sufficient. When we setup the docs with @amitabhverma, we should figure out how we can include the example gallery, such as this for iohub: https://czbiohub-sf.github.io/iohub/main/auto_examples/index.html

@talonchandler can you start an issue on this or point me to one?

@mattersoflight
Copy link
Member

Hi @talonchandler this version of README seems consistent with #446. Please check and we can merge these two PRs.

@talonchandler
Copy link
Collaborator Author

Thanks @mattersoflight, just added your suggestions with minor changes and this is ready to go. Ready to approve and merge IMO.

@talonchandler talonchandler merged commit b4f5d6a into main Jul 10, 2025
11 checks passed
@talonchandler talonchandler deleted the readme-improvement branch July 10, 2025 15:35
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.

3 participants