hydrologie
Cannot 'pip install xhydro' on windows
Setup Information
- xhydro version: v0.3.6
- Python version: 3.12.3
- Operating System: Windows
Description
Trying to install xhydro with pip on windows with pip install xhydro results in an error when building the wheel for raven-hydro:
Building wheels for collected packages: raven-hydro
Building wheel for raven-hydro (pyproject.toml) ... error
error: subprocess-exited-with-error
× Building wheel for raven-hydro (pyproject.toml) did not run successfully.
│ exit code: 1
╰─> [38 lines of output]
*** scikit-build-core 0.9.8 using CMake 3.29.6 (wheel)
*** Configuring CMake...
2024-07-02 14:41:20,456 - scikit_build_core - WARNING - Can't find a Python library, got libdir=None, ldlibrary=None, multiarch=None, masd=None
loading initial cache file build\CMakeInit.txt
-- Building for: Visual Studio 17 2022
-- CMAKE_BUILD_TYPE set to ''
CMake Warning (dev) in CMakeLists.txt:
A logical block opening on the line
C:/Users/KAMIL PC/AppData/Local/Temp/pip-install-_jrlkrk1/raven-hydro_3e654a4004f8426d80ea2d67005ff33e/CMakeLists.txt:33 (IF)
closes on the line
C:/Users/KAMIL PC/AppData/Local/Temp/pip-install-_jrlkrk1/raven-hydro_3e654a4004f8426d80ea2d67005ff33e/CMakeLists.txt:36 (ENDIF)
with mis-matching arguments.
This warning is for project developers. Use -Wno-dev to suppress it.
-- Selecting Windows SDK version 10.0.22621.0 to target Windows 10.0.19045.
-- The CXX compiler identification is MSVC 19.39.33522.0
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Check for working CXX compiler: C:/Program Files (x86)/Microsoft Visual Studio/2022/BuildTools/VC/Tools/MSVC/14.39.33519/bin/Hostx64/x64/cl.exe - skipped
-- Detecting CXX compile features
-- Detecting CXX compile features - done
-- Sources found: C:/Users/KAMIL PC/AppData/Local/Temp/pip-install-_jrlkrk1/raven-hydro_3e654a4004f8426d80ea2d67005ff33e/RavenHydroFramework
-- Modified compile flags with '-Dnetcdf'
CMake Error at C:/Users/KAMIL PC/AppData/Local/Temp/pip-build-env-n7rk5gyy/normal/Lib/site-packages/cmake/data/share/cmake-3.29/Modules/FindPackageHandleStandardArgs.cmake:230 (message):
Could NOT find NetCDF (missing: NetCDF_LIBRARY NetCDF_INCLUDE_DIR)
Call Stack (most recent call first):
C:/Users/KAMIL PC/AppData/Local/Temp/pip-build-env-n7rk5gyy/normal/Lib/site-packages/cmake/data/share/cmake-3.29/Modules/FindPackageHandleStandardArgs.cmake:600 (_FPHSA_FAILURE_MESSAGE)
helpers/FindNetCDF.cmake:194 (find_package_handle_standard_args)
CMakeLists.txt:73 (find_package)
-- Configuring incomplete, errors occurred!
*** CMake configuration failed
[end of output]
note: This error originates from a subprocess, and is likely not a problem with pip.
ERROR: Failed building wheel for raven-hydro
Failed to build raven-hydro
ERROR: ERROR: Failed to build installable wheels for some pyproject.toml based projects (raven-hydro)
sebastienlanglois told me the problem is fixable on linux by running
sudo apt-get install gcc libnetcdf-dev gdal proj geos,
but that there is currently no solution for windows.
Steps To Reproduce
pip install xhydro
Additional context
Note that i ran pip install xhydro in the cmd with python version 3.12.3, so the problem is not related to any environment configuration
Contribution
- [ ] I would be willing/able to open a Pull Request to address this bug.
@Sci-pio Thanks for raising the issue. This has been on my backlog for a few weeks (shoutout to @richardarsenault).
The situation here is pretty simple: In order to install RavenPy you must have system-level NetCDF4 libraries in order to compile the RavenHydroFramework model (supplied by the raven-hydro package on PyPI: https://pypi.org/project/raven-hydro/). We don't offer wheels (binaries) on PyPI since there are a lot of configurations possible (Widows/macOS/Linux * x86_64/x86/AArch64/PowerPC/etc.). Each binary has a size of around 3 MB, and space is limited on PyPI.
There's also the issue around licensing of binaries. We would need to be compiling a library that provides NetCDF4 and the RavenHydroFramework library. Each of these have licensing specifications that we need to respect: NetCDF-C and RavenHydroFramework. In order to provide a binary for RavenHydroFramework on PyPI (via raven-hydro), the Artistic License 2.0 asks that we add a bunch of documentation, which is feasible but is extra effort. I can open a ticket about this.
The alternative approach is to have the NetCDF4 libraries on your system already. Unidata provides some pre-built binaries of NetCDF4 (https://docs.unidata.ucar.edu/netcdf-c/current/winbin.html), but unfortunately, installing these libraries requires access to a Windows 10/11 UI (AFAIK, there are no command-line approaches to installing these libraries; believe me, I've spent many hours looking into this, but if you know of a way, please share it!).
If Anaconda Python is not available, this makes it nearly impossible to ensure Windows support in a pure Python installation is guaranteed.
All this being said, here's my suggestion:
- Install the NetCDF4 binaries in your Windows system, ensuring that they're available in your shell (try running
$ nc-configto test this). - Then try installing
raven-hydro:$ pip install raven-hydro - If that all works, try installing
xhydroaftewards:$ pip install xhydro.
If it's alright with you, I'd like to transfer this issue to https://github.com/Ouranosinc/raven-hydro since it really belongs there. Would that be alright?
@Sci-pio Please post any updates in https://github.com/Ouranosinc/raven-hydro/issues/41. Transferring issues between organisations isn't allowed.
At the MELCCFP, where admin rights on Windows are tricky, we are used to installing xhydro with --no-deps due to this issue. Would moving raven-hydro to an optional dependency be an option?
Hi @essicolo, this has been a thing on the to-do list for a long while. I want to release a version of RavenPy with the newly unpinned dependencies, and maybe we can release a patch next week with this fix.