Fix Windows build and set up Windows CI (#6)

* Fix some Windows problems and update README.md

* Set up Appveyor

* Enable tests in Appveyor

* Enable tests in Appveyor

* Fix libzmq build on Linux

* Fix Cppcheck setup

* Add libtorch to PATH in Appveyor

Author: Isaac Poulton

.gitignore

@@ -1,3 +1,5 @@
 build/
 .vscode/
+.vs/
+.pytest_cache/
 *.pyc

.gitmodules

@@ -2,5 +2,8 @@
 	path = lib/spdlog
 	url = git@github.com:gabime/spdlog.git
 [submodule "lib/msgpack-c"]
-	path = lib/msgpack-c
+	path = example/lib/msgpack-c
 	url = git@github.com:msgpack/msgpack-c.git
+[submodule "example/lib/libzmq"]
+	path = example/lib/libzmq
+	url = git@github.com:Omegastick/libzmq.git

CMakeLists.txt

@@ -12,14 +12,15 @@ set(CMAKE_CXX_STANDARD 17)
 list(APPEND CPPCHECK_ARGS
     --enable=warning
     --std=c++14
-    --verbose
     --force
+    --verbose
     --quiet
     --inline-suppr
     --error-exitcode=1
     --language=c++
     --config-exclude=${CMAKE_CURRENT_LIST_DIR}/src/third_party
     --config-exclude=${CMAKE_CURRENT_LIST_DIR}/lib
+    -i${CMAKE_CURRENT_LIST_DIR}/example/lib
     --suppressions-list=${CMAKE_CURRENT_LIST_DIR}/CppCheckSuppressions.txt 
     -I ${CMAKE_CURRENT_LIST_DIR}/src 
     -I ${CMAKE_CURRENT_LIST_DIR}/include 
@@ -54,7 +55,7 @@ endif(CPPRL_BUILD_TESTS)
 
 # Enable all warnings
 if(MSVC)
-    target_compile_options(cpprl PRIVATE /W4 /WX)
+    target_compile_options(cpprl PRIVATE /W0)
 else(MSVC)
     target_compile_options(cpprl PRIVATE -Wall -Wextra -pedantic)
 endif(MSVC)  

README.md

@@ -44,15 +44,25 @@ Note: The Gym server and client aren't very well optimized, especially when it c
 CMake is used for the build system. 
 Most dependencies are included as submodules (run `git submodule update --init --recursive` to get them).
 Libtorch has to be [installed seperately](https://pytorch.org/cppdocs/installing.html).
-The OpenAI Gym client also uses [Zmpqpp](https://github.com/zeromq/zmqpp), which can be installed with `sudo apt-get install libzmqpp-dev`.
+
+### Linux
 ```bash
 cd pytorch-cpp-rl
 mkdir build && cd build
 cmake ..
 make -j4
 ```
 
-Windows build instructions coming soon.
+### Windows
+```
+cd pytorch-cpp-rl
+mkdir build && cd build
+cmake -G "Visual Studio 15 2017 Win64" -DCMAKE_PREFIX_PATH=C:/path/to/libtorch ..
+cmake --build . --config Release
+```
+Before running, make sure to add `libtorch/lib` to your `PATH` environment variable.
+
+Windows performance is about 75% that of Linux's at the moment. I'm looking into how to speed things up.
 
 ## Testing
-You can run the tests with `build/cpprl_tests`.
+You can run the tests with `build/cpprl_tests` (`build/Release/cpprl_tests.exe` on Windows).

appveyor.yml

@@ -0,0 +1,30 @@
+version: '1.0.0-{build}'
+
+clone_folder: C:\pytorch-cpp-rl
+
+image:
+- Visual Studio 2017
+
+platform:
+- x64
+
+before_build:
+# Load submodules
+- sed -i 's/git@github.com:/https:\/\/github.com\//' .gitmodules
+- git submodule update --init --recursive
+# Install libtorch
+- curl -fsS -o libtorch.zip https://download.pytorch.org/libtorch/cpu/libtorch-win-shared-with-deps-latest.zip
+- 7z x libtorch.zip -y -oC:\
+- set PATH=C:\libtorch\lib;%PATH%
+# Run CMake
+- mkdir build
+- cd build
+- cmake -G "Visual Studio 15 2017 Win64" -DCMAKE_PREFIX_PATH=C:\libtorch ..
+
+build_script:
+- cmake --build . --config Release
+
+test_script:
+- dir
+- cd Release
+- cpprl_tests.exe

example/CMakeLists.txt

@@ -1,11 +1,22 @@
 add_executable(gym_client gym_client.cpp communicator.cpp)
 
+set(LIB_DIR ${CMAKE_CURRENT_LIST_DIR}/lib)
+set(CPPZMQ_DIR ${LIB_DIR}/cppzmq)
+set(MSGPACK_DIR ${LIB_DIR}/msgpack-c)
+set(ZMQ_DIR ${LIB_DIR}/libzmq)
+
+# ZMQ
+option(ZMQ_BUILD_TESTS "" OFF)
+add_subdirectory(${ZMQ_DIR})
+
 target_include_directories(gym_client 
     PRIVATE
     .
     ../include
-    ../lib/msgpack-c/include
     ../lib/spdlog/include
+    ${CPPZMQ_DIR}
+    ${MSGPACK_DIR}/include
+    ${ZMQ_DIR}/include
 )
 
-target_link_libraries(gym_client PRIVATE zmq cpprl)
+target_link_libraries(gym_client PRIVATE libzmq-static cpprl)

example/communicator.cpp

@@ -1,11 +1,11 @@
 #include <memory>
 #include <string>
 
-#include <zmq.hpp>
 #include <spdlog/spdlog.h>
 
 #include "communicator.h"
 #include "requests.h"
+#include "third_party/zmq.hpp"
 
 namespace gym_client
 {

example/communicator.h

@@ -6,11 +6,11 @@
 #include <string>
 
 #include <msgpack.hpp>
-#include <zmq.hpp>
 #include <spdlog/spdlog.h>
 #include <spdlog/fmt/bundled/ostream.h>
 
 #include "requests.h"
+#include "third_party/zmq.hpp"
 
 namespace gym_client
 {

example/gym_client.cpp

@@ -152,7 +152,7 @@ int main(int argc, char *argv[])
                                          storage.get_masks()[step]);
             }
             auto actions_tensor = act_result[1].cpu();
-            long *actions_array = actions_tensor.data<long>();
+            int64_t *actions_array = actions_tensor.data<int64_t>();
             std::vector<std::vector<int>> actions(num_envs);
             for (int i = 0; i < num_envs; ++i)
             {