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

Make Mayavi optional #455

Merged
merged 6 commits into from
Mar 7, 2023
Merged

Make Mayavi optional #455

merged 6 commits into from
Mar 7, 2023

Conversation

yoda-vid
Copy link
Collaborator

@yoda-vid yoda-vid commented Mar 6, 2023

Addresses #401.

The Mayavi package provides 3D viewing but is not essential to the rest of the application. Mayavi installation has also been causing sporadic errors, which can interrupt environment setup for MagellanMapper.

This PR moves the package into a 3d optional dependencies group, installed in the all but not the most group. When users attempt to 3D viewer, instructions are provided to install Mayavi via Pip.

yoda-vid added 4 commits March 3, 2023 16:50
The Mayavi package provides 3D viewing but is not essential to the rest of the application. Move the package into a `3d` optional dependencies group, installed in the `all` but not the `most` group. Provide user instructions to install Mayavi when attempting 3D viewing.
Remove extra space if `task` is not provided.
Limit version exclusion to 5.15.8 since 5.15.9 appears to launch without error.
- Regenerate requirements without the Mayavi dependency
- Python 3.6 requirements simplified to not include version-specific dependencies since the listing is only meant for Python 3.6
@yoda-vid yoda-vid added the dependencies Issues/requests related to a dependency package label Mar 6, 2023
yoda-vid added 2 commits March 7, 2023 09:56
- Summarize installation groups in a table
- Remove listing of dependency types
- Small description simplifications
- Add FAQ on Mayavi installation
@yoda-vid yoda-vid merged commit d9b207f into master Mar 7, 2023
@yoda-vid yoda-vid deleted the mayavi_optional branch March 7, 2023 02:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Issues/requests related to a dependency package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant