Homebrew formula

[sbryngelson]

User description

Homebrew formula

---

PR Type

Enhancement, Documentation

---

Description

• Add Homebrew formula for macOS installation of MFC

• Create comprehensive Homebrew documentation covering installation and usage

• Organize packaging files into dedicated packaging/homebrew/ directory

• Remove issue templates and consolidate to Homebrew-specific content

---

Diagram Walkthrough

flowchart LR
  A["Homebrew Formula<br/>mfc.rb"] -- "defines" --> B["Installation<br/>Process"]
  B -- "installs" --> C["Binaries<br/>pre_process, simulation,<br/>post_process"]
  B -- "installs" --> D["Wrapper Script<br/>mfc"]
  B -- "installs" --> E["Python Toolchain<br/>& Examples"]
  F["HOMEBREW.md<br/>Documentation"] -- "explains" --> B
  F -- "guides" --> G["Users"]

Loading

File Walkthrough

	Relevant files
Enhancement	mfc.rb Homebrew formula for MFC installation                                        packaging/homebrew/mfc.rb Defines Homebrew formula class for MFC with version 5.1.0 Specifies build dependencies (cmake, gcc, [email protected]) and runtime dependencies (boost, fftw, hdf5, open-mpi, openblas) Implements install method that builds three binaries and creates wrapper script Includes test suite verifying binary existence and wrapper functionality Provides post-installation caveats with usage examples and documentation links +82/-0
Documentation	HOMEBREW.md Complete Homebrew installation and usage guide                      packaging/homebrew/HOMEBREW.md Comprehensive documentation covering Homebrew formula structure and dependencies Details build process, environment configuration, and wrapper script functionality Explains installation methods (standard and development HEAD installations) Documents testing procedures, post-installation setup, and usage examples Covers distribution methods, platform support, versioning, and technical details Highlights advantages over manual installation and maintenance requirements +211/-0
Miscellaneous	bug_report.md Remove bug report issue template                                                  .github/ISSUE_TEMPLATE/bug_report.md Removed bug report issue template from repository Consolidation of branch to focus solely on Homebrew packaging +0/-30

---

[qodo-merge-pro]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Duplicate Code The wrapper script is created twice in the install method. First, mfc.sh is installed as mfc at line 37, then immediately overwritten with a new bash script at lines 46-51. The first installation is redundant and should be removed. # Install the mfc.sh wrapper bin.install "mfc.sh" => "mfc" # Install Python toolchain prefix.install "toolchain" # Install examples pkgshare.install "examples" # Create a simple wrapper that sets up the environment (bin/"mfc").write <<~EOS #!/bin/bash export BOOST_INCLUDE="#{Formula["boost"].opt_include}" exec "#{prefix}/mfc.sh" "$@" EOS chmod 0755, bin/"mfc" Possible Issue The mfc wrapper script references #{prefix}/mfc.sh but mfc.sh is never installed to the prefix directory. Line 37 installs it to bin/mfc which gets overwritten. The script should either install mfc.sh to prefix or reference it from the source directory. (bin/"mfc").write <<~EOS #!/bin/bash export BOOST_INCLUDE="#{Formula["boost"].opt_include}" exec "#{prefix}/mfc.sh" "$@" Missing Tests The test suite only verifies that binaries exist and that the wrapper accepts --help. It doesn't test actual functionality like running a simple example case or verifying that the installed binaries can execute successfully. Consider adding a basic functional test. test do # Test that the binaries exist and run assert_predicate bin/"pre_process", :exist? assert_predicate bin/"simulation", :exist? assert_predicate bin/"post_process", :exist? # Test mfc wrapper system bin/"mfc", "--help" end

[Copilot]

Pull Request Overview

This PR adds Homebrew packaging support for MFC on macOS, enabling users to install MFC via brew install mfc. The changes include a Ruby formula file for Homebrew and comprehensive documentation.

• Adds Homebrew formula (mfc.rb) defining dependencies, build process, and installation logic
• Provides detailed documentation (HOMEBREW.md) explaining the formula structure and usage
• Removes the old bug report issue template

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.

File	Description
packaging/homebrew/mfc.rb	Homebrew formula that builds and installs MFC with all dependencies
packaging/homebrew/HOMEBREW.md	Complete documentation for the Homebrew packaging system
.github/ISSUE_TEMPLATE/bug_report.md	Removes outdated bug report template

[sbryngelson]

/improve

[Copilot]

Pull Request Overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

[sbryngelson]

/improve

[qodo-merge-pro]

Suggestion: Replace the brittle log-parsing check for Homebrew installation success with more robust brew list and brew info commands to verify the package is installed. [possible issue, importance: 7]

Suggested change

	- name: Install MFC from formula
	run: |
	echo "Creating temporary local tap..."
	brew tap-new mflowcode/test
	echo "Copying formula to tap..."
	cp packaging/homebrew/mfc.rb $(brew --repository)/Library/Taps/mflowcode/homebrew-test/Formula/mfc.rb
	echo "Installing MFC from local tap..."
	# Note: brew may exit with code 1 due to dylib fixup warnings on some Python packages (non-fatal)
	# We check for successful installation (🍺 symbol) rather than just exit code
	set +e # Don't fail immediately on error
	brew install --build-from-source --verbose mflowcode/test/mfc 2>&1 | tee /tmp/brew-install.log
	brew_exit_code=$?
	set -e
	# Check if the formula actually installed successfully
	if grep -q "🍺.*mfc.*built in" /tmp/brew-install.log; then
	echo "✅ MFC installed successfully (ignoring dylib relocation warnings)"
	exit 0
	else
	echo "❌ MFC installation failed"
	exit $brew_exit_code
	fi
	- name: Install MFC from formula
	run: |
	echo "Creating temporary local tap..."
	brew tap-new mflowcode/test
	echo "Copying formula to tap..."
	cp packaging/homebrew/mfc.rb $(brew --repository)/Library/Taps/mflowcode/homebrew-test/Formula/mfc.rb
	echo "Installing MFC from local tap..."
	set +e
	brew install --build-from-source --verbose mflowcode/test/mfc 2>&1 | tee /tmp/brew-install.log
	brew_exit_code=$?
	set -e
	echo "Verifying installation via brew..."
	if brew list --versions mfc >/dev/null 2>&1; then
	echo "✅ MFC appears installed (brew list)"
	exit 0
	fi
	# As an extra check, try brew info --json to detect installation
	if brew info --json=v2 mfc | grep -q '"installed":\s*\['; then
	echo "✅ MFC appears installed (brew info)"
	exit 0
	fi
	echo "❌ MFC installation failed"
	exit $brew_exit_code

[qodo-merge-pro]

Suggestion: Convert the Pathname object venv to a string using .to_s before assigning it to the ENV["VIRTUAL_ENV"] environment variable for improved robustness. [possible issue, importance: 4]

Suggested change

	ENV["VIRTUAL_ENV"] = venv
	ENV["VIRTUAL_ENV"] = venv.to_s

[qodo-merge-pro]

Suggestion: Add a check after Dir.glob to ensure that binaries were found. If not, fail the installation with an error message using odie to prevent a broken installation. [possible issue, importance: 7]

Suggested change

	# Install binaries - they're in hashed subdirectories like build/install/<hash>/bin/*
	Dir.glob("build/install/*/bin/*").each do |binary_path|
	bin.install binary_path
	end
	# Install binaries - they're in hashed subdirectories like build/install/<hash>/bin/*
	binaries = Dir.glob("build/install/*/bin/*")
	odie "No binaries found under build/install/*/bin/*; build may have failed." if binaries.empty?
	binaries.each do |binary_path|
	bin.install binary_path
	end

[qodo-merge-pro]

✅ Suggestion: Harden the generated shell wrapper script by adding set -euo pipefail, quoting all variable expansions and paths, and ensuring the trap command is safe to prevent unexpected runtime failures. [general, importance: 7]

Suggested change

	wrapper_script.write <<~EOS
	#!/bin/bash
	set -e
	# Unset VIRTUAL_ENV to ensure mfc.sh uses the copied venv, not the Cellar one
	unset VIRTUAL_ENV
	# Create a temporary working directory (Cellar is read-only)
	TMPDIR=$(mktemp -d)
	trap "rm -rf $TMPDIR" EXIT
	# Copy mfc.sh to temp dir (it may try to write build artifacts)
	cp "#{libexec}/mfc.sh" "$TMPDIR/"
	cd "$TMPDIR"
	# Copy toolchain directory (not symlink) so Python paths resolve correctly
	# This prevents paths from resolving back to read-only Cellar
	cp -R "#{prefix}/toolchain" toolchain
	# Patch toolchain to use Homebrew-installed binaries
	# Replace get_install_binpath to return Homebrew bin directory
	cat >> toolchain/mfc/build.py << 'PATCH_EOF'
	# Homebrew patch: Override get_install_binpath to use pre-installed binaries
	_original_get_install_binpath = MFCTarget.get_install_binpath
	def _homebrew_get_install_binpath(self, case):
	return "#{bin}/" + self.name
	MFCTarget.get_install_binpath = _homebrew_get_install_binpath
	# Override is_buildable to skip building main targets and syscheck
	_original_is_buildable = MFCTarget.is_buildable
	def _homebrew_is_buildable(self):
	if self.name in ["pre_process", "simulation", "post_process", "syscheck"]:
	return False # Skip building - use pre-installed binaries
	return _original_is_buildable(self)
	MFCTarget.is_buildable = _homebrew_is_buildable
	PATCH_EOF
	# Copy examples directory (required by mfc.sh Python code)
	cp -R "#{prefix}/examples" examples
	# Create build directory and copy venv (not symlink - needs to be writable)
	# Use cp -R for a full recursive copy
	mkdir -p build
	cp -R "#{venv}" build/venv
	# Copy pyproject.toml to build/ so mfc.sh thinks dependencies are already installed
	cp "#{prefix}/toolchain/pyproject.toml" build/pyproject.toml
	# For 'mfc run', add --no-build flag to skip compilation
	if [ "$1" = "run" ]; then
	exec ./mfc.sh "$@" --no-build
	else
	exec ./mfc.sh "$@"
	fi
	EOS
	wrapper_script.write <<~EOS
	#!/bin/bash
	set -euo pipefail
	# Unset VIRTUAL_ENV to ensure mfc.sh uses the copied venv, not the Cellar one
	unset VIRTUAL_ENV || true
	# Create a temporary working directory (Cellar is read-only)
	TMPDIR="$(mktemp -d)"
	trap 'rm -rf "${TMPDIR}"' EXIT
	# Copy mfc.sh to temp dir (it may try to write build artifacts)
	cp "#{libexec}/mfc.sh" "${TMPDIR}/"
	cd "${TMPDIR}"
	# Copy toolchain directory (not symlink) so Python paths resolve correctly
	cp -R "#{prefix}/toolchain" "toolchain"
	# Patch toolchain to use Homebrew-installed binaries
	# Replace get_install_binpath to return Homebrew bin directory
	cat >> "toolchain/mfc/build.py" << 'PATCH_EOF'
	...
	# Copy examples directory (required by mfc.sh Python code)
	cp -R "#{prefix}/examples" "examples"
	# Create build directory and copy venv (not symlink - needs to be writable)
	mkdir -p "build"
	cp -R "#{venv}" "build/venv"
	# Copy pyproject.toml to build/ so mfc.sh thinks dependencies are already installed
	cp "#{prefix}/toolchain/pyproject.toml" "build/pyproject.toml"
	# For 'mfc run', add --no-build flag to skip compilation
	if [ "${1-}" = "run" ]; then
	exec ./mfc.sh "$@" --no-build
	else
	exec ./mfc.sh "$@"
	fi
	EOS

[Copilot]

Pull Request Overview

Copilot reviewed 4 out of 5 changed files in this pull request and generated 3 comments.

[Copilot]

The wrapper script uses bash-specific features (e.g., process substitution) but doesn't set strict error handling early enough. Consider adding set -euo pipefail instead of just set -e to catch unset variables and pipeline failures, which would make the script more robust.

Suggested change

	set -e
	set -euo pipefail