Eddy3D - Airflow and Microclimate Simulations for Rhino & Grasshopper

Release Branching

Eddy3D uses a promotion cascade for releases:

• dev is the active integration branch.
• pre-release is used to publish installer and Yak pre-releases for validation.
• release is used only for production releases.

The intended flow is dev -> pre-release -> release. Avoid merging feature branches directly into release. Since Yak package versions cannot be re-published, only promote to pre-release when the version is intentionally ready to publish.

Development Setup (Windows)

Windows checkout steps

To check out the project for development on Windows, ensure you configure Git like this:

# Create the parent directory if it doesn't exist
# This uses the current user's profile path
mkdir "$env:USERPROFILE\Documents\GitHub\Eddy3D-Dev" -ErrorAction SilentlyContinue
cd "$env:USERPROFILE\Documents\GitHub\Eddy3D-Dev"

# Clone the project
git clone https://github.com/Eddy3D-Dev/Eddy3D.git
cd Eddy3D

Development Setup (macOS)

macOS checkout steps

To check out the project for development on macOS, run:

# Create the parent directory if it doesn't exist
mkdir -p "$HOME/Documents/GitHub/Eddy3D-Dev"
cd "$HOME/Documents/GitHub/Eddy3D-Dev"

# Clone the project
git clone https://github.com/Eddy3D-Dev/Eddy3D.git
cd Eddy3D

Unit Tests & General Testing

Test policy

For xUnit test execution behavior across Windows/macOS (run/skip/fail-fast rules and required attributes), see:

• RhinoPlugin.Test.Xunit/TEST_POLICY.md