Build wheels across Python 3.9–3.11 for Linux, macOS, and Windows

[ReeceHumphreys]

• Tickets addressed: bsk-1081
• Review: By commit
• Merge strategy: Merge (no squash)

Description

This PR adds a new workflow which uses cibuildwheel to build wheels for multiple python versions across a variety of operating systems.

Verification

I temporarily had the workflow execute on pushes to this brach for testing. Here is a link which shows the bundled wheels for each os:

https://github.com/AVSLab/basilisk/actions/runs/17392301611

NOTE: Some of these wheel distributions do not include all of our "supported" Python versions. For example, we technically support Python 3.8 on macOS but the ARM builds of wheels require at least python 3.9.

Documentation

N/A

Future work

Publish these wheels whenever we release a new version to PyPI.

[ReeceHumphreys]

Only commit 2915edb should be reviewed. The other two commits are from PR #1073. PR #1073 is required to be merged before this PR as we leverage the refactor to make this PR simpler.

[dpad]

Hi @ReeceHumphreys ,

Apologies for jumping in on this review, but thank you very much for your efforts on this!

I wanted to just recommend the following option, since in my previous experience it greatly reduced the size of the compiled Basilisk wheel file for Linux (down to ~200MB):

[tool.cibuildwheel.linux]
repair-wheel-command = [
  # Minimise the wheel size by stripping unnecessary symbols from the compiled objects.
  "auditwheel repair --strip -w {dest_dir} {wheel}"
]

Also, you're probably already aware, but you can run tests directly after building each wheel to ensure they install and run correctly. For example:

[tool.cibuildwheel]
# NOTE: You'll need to ensure pytest is installed, e.g. in an optional dependency group using `test-extras`
test-command = [
  "cd {package}/src && pytest -v . -m \"not scenarioTest\""
]

[schaubh]

Howdy @dpad , good to hear from you. @ReeceHumphreys just joined my lab this fall and has excellent software development skills. He is helping me get these pip wheels onto PyPi and improve the CI test build scripts. We appreciate any feedback or suggestions you want to share.

[ReeceHumphreys]

Hi @ReeceHumphreys ,

Apologies for jumping in on this review, but thank you very much for your efforts on this!

I wanted to just recommend the following option, since in my previous experience it greatly reduced the size of the compiled Basilisk wheel file for Linux (down to ~200MB):

[tool.cibuildwheel.linux]
repair-wheel-command = [
  # Minimise the wheel size by stripping unnecessary symbols from the compiled objects.
  "auditwheel repair --strip -w {dest_dir} {wheel}"
]

Hello @dpad!

Thanks for the suggestion! I did notice that the Linux wheels were fairly large during testing, but I haven’t looked into it yet since I’ve mainly been testing on macOS and Windows. Once I move on to Linux testing, I’ll incorporate your suggestion and verify everything still works as expected.

Also, you're probably already aware, but you can run tests directly after building each wheel to ensure they install and run correctly. For example:

[tool.cibuildwheel]
# NOTE: You'll need to ensure pytest is installed, e.g. in an optional dependency group using `test-extras`
test-command = [
  "cd {package}/src && pytest -v . -m \"not scenarioTest\""
]

This is essentially how I have been testing the wheels myself locally! I am not sure yet if it needs to be a part of our CI/CD pipeline as we already test all of the code across all OSes as part of another workflow. Once the wheel builds are working fully as expected adding this to the CI would do is be verifying is that cibuildwheel does indeed produce correct wheels.

This feels like we would be verifying cibuildwheels functionality more than anything. Im not necessarily opposed to adding it as a check though.

[ReeceHumphreys]

Here is a test of the workflow that I triggered. Looks like all of the wheels are much more reasonable in size after an optimization pass. Linux is now around 75 MB per wheel:

https://github.com/AVSLab/basilisk/actions/runs/17571574748

[schaubh]

Great changes. I like how you refactored the commit to make the review much easier. Good work :-)