Add a macOS setup section to the README - #327
Merged
Merged
Conversation
The 'Platforms supported' entry for macOS was three lines pointing to an external forum thread, and 'Setting up the CfdOF workbench' had no macOS subsection at all, unlike Windows and Linux which both have detailed, step-by-step instructions. Adds a macOS subsection with the same structure: official FreeCAD install, Addon Manager steps for CfdOF itself, and dependency installation. Also documents two gotchas found while getting CfdOF running on macOS that aren't specific to any one setup: - conda-forge's FreeCAD package for macOS (tested across two versions) is missing a Qt/shiboken type converter needed to read values back from CfdOF's numeric input fields, so most panels fail with RuntimeError as soon as a value is saved. Reproduces on a bare Gui::InputField with no CfdOF code involved. The official installer does not have this problem. - Two different FreeCAD builds sharing the same version-scoped profile directory can cause native crashes unrelated to either build or to CfdOF. Updates the 'Platforms supported' blurb to reflect that macOS is now documented rather than just pointing out to a forum thread.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The README's macOS coverage was thin compared to Windows and Linux: the "Platforms supported" entry was three lines pointing to an external forum thread, and "Setting up the CfdOF workbench" had no macOS subsection at all, while Windows and Linux each get detailed, step-by-step instructions.
This adds a macOS subsection with the same structure as the existing Windows/Linux ones: official FreeCAD install, Addon Manager steps for CfdOF itself, and dependency installation (OpenFOAM/ParaView/cfMesh/HiSA).
Two things flagged along the way
While getting CfdOF running on macOS, I ran into two issues that aren't specific to any one setup, so I documented them rather than leaving future users to rediscover them:
RuntimeError: Can't find converter for 'Base::Quantity'as soon as a value is saved. This reproduces on a bareGui::InputFieldwidget with no CfdOF code involved, so it's a property of that build rather than something CfdOF can work around. FreeCAD's own official installer does not have this problem.~/Library/Application Support/FreeCAD/vX-Y) can cause native crashes unrelated to either build individually or to CfdOF. Worth a one-line caution for anyone comparing builds.I've kept these fairly brief and focused on what a user needs to know and do — happy to trim, reword, or drop either one if you'd rather keep the README leaner and handle this kind of detail elsewhere (an issue, a wiki page, etc.). Similarly, if the overall length or level of detail doesn't fit how you'd like this section to read, I'm happy to revise.
Testing
Documentation-only change, no code touched.