Skip to content

Conversation

@Ralph-20
Copy link
Collaborator

@Ralph-20 Ralph-20 commented Nov 4, 2025

Windows Installation Fix: Cython Compilation Verification

Problem

Windows users getting ImportError: cannot import name 'cython_functions' because Cython extensions weren't compiled during installation. No clear guidance when compilation failed.

Solution

Added verification script and comprehensive troubleshooting documentation.

Changes

New Files

  • scripts/verify_installation.py - Detects missing Cython extensions, provides platform-specific fixes
  • docs/windows-setup.md - Complete Windows troubleshooting guide with two solutions (conda tools vs Visual Studio)

Updated Files

  • README.md - Added verification step to Quick Start, Windows troubleshooting section
  • docs/getting-started.md - Enhanced setup instructions, added Cython compilation guidance

Usage

Verify installation:

python scripts/verify_installation.py

Quick fix for Windows Cython errors:

conda install -c conda-forge m2w64-toolchain libpython
pip install -e . --no-deps --force-reinstall

Impact

  • ✅ Zero risk - No changes to environment.yml or CI/CD
  • ✅ Self-service troubleshooting for Windows users
  • ✅ Clear detection of installation issues
  • ✅ Platform-specific guidance (Windows/Mac/Linux)

Testing

  • ✅ Verification script tested on macOS (all checks pass)
  • ✅ No linter errors
  • ✅ Documentation links verified

@jandrewjohnson jandrewjohnson deleted the branch develop December 11, 2025 18:21
@jandrewjohnson jandrewjohnson deleted the feature/test-infra branch December 11, 2025 18:21
@jandrewjohnson jandrewjohnson restored the feature/test-infra branch December 11, 2025 18:25
@Ralph-20 Ralph-20 reopened this Dec 12, 2025
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.

3 participants