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

Add documentation and script for detector setup #57

Merged
merged 1 commit into from
Jul 4, 2024

Conversation

keiranbarr
Copy link
Collaborator

Added additional documentation to doc/setup.md, as well as creating an image generation script for the detectors.

This was created in response to issue #56

@keiranbarr keiranbarr mentioned this pull request Jul 3, 2024
Copy link
Collaborator

@lassoan lassoan left a comment

Choose a reason for hiding this comment

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

Thank you, this is very useful. I would test the instructions on WIndows, so it would be great if you could add a section for that.


Please see the section that pertains to your operating system below.

## Windows
### Windows

Please install a recent version of Visual Studio Build Tools: https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2022
Copy link
Collaborator

Choose a reason for hiding this comment

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

If this is needed then it indicates that there is a Python package that does not have wheels. Packages that do not have wheels are often lower quality, not well maintained, not widely used, so we should review if we really want to use such packages. Do you know which package does not have wheels?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

When I test on my system I believe it is wxpython and pyopengl-accelerate. The wxpython wheel in particular takes a very long time to build.

doc/setup.md Outdated Show resolved Hide resolved
doc/setup.md Show resolved Hide resolved

This system is intended to be used over a LAN connecting Raspberry Pi -based detector(s) and a main computer. The Raspberry Pi's run the src.main_detector, while the main computer runs the src.main_pose_solver and optionally the src.gui.gui module.

To setup the Raspberry Pi -based detectors, run the setup/create_image.sh script on a compatible linux system. Flash the resulting image to a microSD card (or multiple) for use.
Copy link
Collaborator

Choose a reason for hiding this comment

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

We cannot dictate what operating system developers should use. If it is absolutely impossible to perform these tasks on any other operating system, then provide instructions for running on docker.

But I suspect that instead of using bash, you could simply implement this in Python, making the project more uniform (all code implemented in Python) and making the code much more cleaner and easier to debug.

@lassoan
Copy link
Collaborator

lassoan commented Jul 3, 2024

@keiranbarr you don't need to fix all the comments right now. If you want then you can create follow-up issues for comments that you don't want to deal with now, merge this PR, and we'll get back to those remaining issues later.

@keiranbarr keiranbarr force-pushed the detector-image-creation-script branch from a9ac0d2 to f9dcc1a Compare July 4, 2024 14:47
@keiranbarr keiranbarr merged commit 7ad2227 into PerkLab:main Jul 4, 2024
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.

2 participants