Skip to content

Remove Bioformats from main install instructions#761

Merged
yoda-vid merged 13 commits intomasterfrom
tif_default_instructions
Dec 31, 2025
Merged

Remove Bioformats from main install instructions#761
yoda-vid merged 13 commits intomasterfrom
tif_default_instructions

Conversation

@yoda-vid
Copy link
Copy Markdown
Collaborator

@yoda-vid yoda-vid commented Dec 6, 2025

Fixes #751. This PR updates the homepage/README instructions to install using the most group, assuming that the latest wheel on PyPi does not install Bioformats/Javabridge for this group.

The configuration of the license file and package discovery without __init__.py for each source subfolder were also fixed in the new pyproject.toml project configuration.

- Show that Bioformats-based method has been replaced by TIF-based approach
- Move up the section on viewing a TIF file without importing
- Add `--savefig npy` as an alternative way to save TIF to NPY, without overwriting
Match the `install.doc` approaches in the main README, assuming that the current release no longer requires a custom repo for installing the `most` group.
Incorporate package discovery from `setup.py` into `pyproject.toml` setup.
@yoda-vid yoda-vid added this to the v1.7.0 milestone Dec 6, 2025
@yoda-vid yoda-vid added bug Something isn't working documentation Improvements or additions to documentation labels Dec 6, 2025
Specifying the flat-layout folder for automatic package discovery removed build errors, but the installed project could not find these packages. Use an `include` statement instead as inspired by astropy/astropy#15403 .
Only show in debugging now that the JVM does not need to be stopped by default.
- Redirect proprietary image format import to software that can export them to TIF
- Replace `run.py` with `mm` command to avoid path-dependence
Now that these packages are deprecated in v1.6, remove them from the installation through Conda. This change matches the release install's group dependencies with the developer installation for Conda environments.
…up in README install instructions

The v1.7a1 pre-release changed the `most` install group to no longer require a custom PyPi repo, but this version is only installed when a `--pre` flag is supplied.

- Change the instructions back to using individual rather than the `most` install group since v1.6 is still installed by default
- Group the install sections undef "Quick Install"
- Add a section for installing the pre-release version, which can be performed in regular or Conda environments
Replace redundant install instructions from the install doc by linking to the README. This change removes the need to update install methods in both places. Also, move the Bioformats Conda section to a deprecated section.
@yoda-vid yoda-vid merged commit fa83b78 into master Dec 31, 2025
24 checks passed
@yoda-vid yoda-vid deleted the tif_default_instructions branch December 31, 2025 18:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update docs to install without the import group

1 participant