Windows installation fails with error: could not create 'build\bdist.win-amd64\wheel\.\idaes\core\surrogate\tests\data\onnx_models\net_st_net_5000_STM_100_s_2000000_60_5_tanh_1e-06 _4096_tr_15481_Calcite_ST_idaes_info.json': No such file or directory

[lbianchi-lbl]

• Originally reported by @MarcusHolly, @hunterbarber, and @OOAmusat
• As suggested by @adam-a-a, the file mentioned in the error was added in Adds ONNX Surrogate support from OMLT #1308
• I was able to reproduce this locally on a Windows VM using:

  conda create --yes -n test-idaes-install-error python=3.11
  conda activate test-idaes-install-error
  pip install "idaes-pse @ git+https://github.com/IDAES/idaes-pse@main"

• My current best guess is that this is due to file path length limitations on Windows
  • See also e.g. https://scikit-learn.org/stable/install.html#error-caused-by-file-path-length-limit-on-windows
• The reason why this issue doesn't show up in CI (and indeed might be impossible to reproduce on GitHub Actions runners) is that the file path length limit is disabled on the Windows version used in GHA: MAX_PATH lengths on Windows environment actions/runner-images#1052

[lbianchi-lbl]

I was able to confirm that this is indeed caused by file path length limitations:

1. In a Powershell prompt, run the following "cmdlet" to check whether long paths are supported or not (0: long paths not supported; 1: long paths supported):

Get-ItemProperty -Path "HKLM:System\CurrentControlSet\Control\FileSystem" -Name "LongPathsEnabled"

2. Run the pip install command above (it should fail if LongPathsEnabled is 0)
3. Open a Powershell prompt with "Run as Administrator" to enable support for long paths:

Set-ItemProperty -Path "HKLM:System\CurrentControlSet\Control\FileSystem" -Name "LongPathsEnabled" -Value 1

4. Run the pip install command above, which should now pass

For more information: https://learn.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation?tabs=registry#enable-long-paths-in-windows-10-version-1607-and-later

[lbianchi-lbl]

From more testing, I think I figured out the exact path that causes the error, at 262 characters when the default length without LongPathsEnabled is 260:

C:\Users\lbian\AppData\Local\Temp\pip-install-is8sb24x\idaes-pse_f27d74dd25594348bdef5015371f125f\build\bdist.win-amd64\wheel\.\idaes\core\surrogate\tests\data\onnx_models\net_st_net_5000_STM_100_s_2000000_60_5_tanh_1e-06_4096_tr_15481_Calcite_ST_idaes_info.json

Assuming this is true, and that the pattern for name mangling that pip uses is fixed in length, then the filename just happens to be long enough to go over the threshold by 2 characters 🙃