Merge pull request #56 from sm-rana/dev-smmr

Made changes to enable compilation on Windows

Author: samhatchett

owa-epanet/CMakeLists.txt

@@ -1,11 +1,21 @@
 cmake_minimum_required(VERSION 3.8)
 
+project(OWA-EPANET)
+
 if(SKBUILD)
   message(STATUS "The project is built using scikit-build")
 endif()
 
 find_package(PythonLibs 3 REQUIRED)
 find_package(PythonInterp ${PYTHONLIBS_VERSION_STRING} REQUIRED)
+# If find_package() has difficulty finding the appropriate python 
+# directories and libraries (especially in Windows with multiple 
+# versions of python) set them manually as in the next three lines 
+# below (and comment out the above two find_package() lines):
+# set(PYTHON_EXECUTABLE "c:/python/python38/python.exe")
+# set(PYTHON_INCLUDE_PATH "c:/python/python38/include")
+# set(PYTHON_LIBRARIES "c:/python/python38/libs/python38.lib")
+
 find_package(SWIG REQUIRED)
 include(${SWIG_USE_FILE})
 set(CMAKE_SWIG_FLAGS -py3)
@@ -33,6 +43,7 @@ SWIG_ADD_LIBRARY( toolkit LANGUAGE python SOURCES wrapper/toolkit.i )
 set_property(SOURCE toolkit.i PROPERTY USE_LIBRARY_INCLUDE_DIRECTORIES TRUE)
 set_property(TARGET epanet2 PROPERTY SWIG_USE_TARGET_INCLUDE_DIRECTORIES TRUE)
 SWIG_LINK_LIBRARIES(toolkit epanet2)
+
 SWIG_LINK_LIBRARIES(toolkit ${PYTHON_LIBRARIES})
 set_property(TARGET _toolkit PROPERTY INSTALL_RPATH "$ORIGIN")
 
@@ -55,11 +66,25 @@ add_custom_command(
                 ${CMAKE_CURRENT_BINARY_DIR}/toolkit.py
                 ${CMAKE_CURRENT_BINARY_DIR}/../../../packages/epanet/toolkit.py)
 
-add_custom_command(
-        TARGET _toolkit POST_BUILD
-        COMMAND ${CMAKE_COMMAND} -E copy
-                ${CMAKE_CURRENT_BINARY_DIR}/lib/libepanet2.*
-                ${CMAKE_CURRENT_BINARY_DIR}/../../../packages/epanet/)
+IF(WIN32)
+    add_custom_command(
+            TARGET _toolkit POST_BUILD
+            COMMAND ${CMAKE_COMMAND} -E copy
+                    ${CMAKE_CURRENT_BINARY_DIR}/lib/Release/_toolkit.pyd
+                    ${CMAKE_CURRENT_BINARY_DIR}/../../../packages/epanet/_toolkit.pyd)
+    add_custom_command(
+            TARGET _toolkit POST_BUILD
+            COMMAND ${CMAKE_COMMAND} -E copy
+                    ${CMAKE_CURRENT_BINARY_DIR}/bin/Release/epanet2.dll
+                    ${CMAKE_CURRENT_BINARY_DIR}/../../../packages/epanet/epanet2.dll)
+ELSE(True)
+    add_custom_command(
+            TARGET _toolkit POST_BUILD
+            COMMAND ${CMAKE_COMMAND} -E copy
+                    ${CMAKE_CURRENT_BINARY_DIR}/lib/libepanet2.*
+                    ${CMAKE_CURRENT_BINARY_DIR}/../../../packages/epanet/)
+ENDIF(WIN32)
+
 
 
 #add_custom_command(

owa-epanet/EPANET

@@ -4,10 +4,17 @@ A slender, auto-generated python wrapper around owa:epanet hydraulic network ana
 
 Where possible, SWIG has been configured to throw warnings/exceptions instead of using the customary EPANET return integer value for success-checking. Also any output (pointer) parameters from the C API have been re-routed to return values. In these cases, the return tuple from the Python API will contain the values desired.
 
-```
 
+## Building the libraries
+
+Ensure the EPANET subproject is populated by running `git submodule update --init` (if necessary) and running the following commands (on Windows skip the line `./script/clean.sh`). The following method uses `scikit-build` to invoke `cmake` for compiling and linking the shared libaries, and builds a python wheel.
+
+```
 ./scripts/clean.sh
 python3 setup.py sdist bdist_wheel
+```
+Test your builds using the following commands.
+```
 cd test && pipenv install ../dist/*.whl && pipenv run python -c 'from epanet import toolkit; print(toolkit.__dict__)'
 
 ```

owa-epanet/README.md

@@ -0,0 +1,23 @@
+cls
+
+rem Bulding the toolkit package for Windows. The preferred way to build the package is by running 'python setup.py sdist bdist_wheel'.
+
+git submodule update --init
+
+SET CMAKE_PATH=cmake.exe
+SET Build_PATH=%CD%
+SET COMPILE_PATH=%Build_PATH%\_cmake_build\windows\cmake-build
+
+MKDIR "%COMPILE_PATH%"
+CD "%COMPILE_PATH%"
+rem Building 64-bit toolkit for 64-bit python.
+rem If 32-bit toolkit is required ensure 32-bit python is located
+rem by cmake (check CmakeList.txt) and replace '%CMAKE_PATH% ../ -A x64'
+rem with '%CMAKE_PATH% ../ -A Win32'."
+%CMAKE_PATH% ../../../ -A x64
+%CMAKE_PATH% --build . --config Release
+
+rem 'After successful compilation "toolkit.py", "_toolkit.pyd", "epanet2.dll" will be created. You can start using the toolkit by importing the module "toolkit.py".
+
+cd ..
+pause