Skip to main content

Windows

NOME can be downloaded as a simple zip file instead of compiling the codebase on Windows! here​

Dependencies​

This section will walk you through the steps for setting up a build environment for JIPCAD on Windows. Here is a list of the required dependencies:

To make your life easier, there are a few package management software on Windows that I would personally recommend:

  • Scoop (We need this for cmake)
  • Vcpkg (We need this for OpenMesh and Qt5)

Please install Visual Studio first, as it is necessary for any C++ development work on Windows. Then you can install scoop and vcpkg; Scoop installation instructions are here: https://scoop.sh/, and vcpkg instructions are here: https://github.com/microsoft/vcpkg (just run git clone https://github.com/microsoft/vcpkg and .\vcpkg\bootstrap-vcpkg.bat first. You'll install the needed packages below). It should be straightforward. Go ahead and spend a few minutes playing with each package management tool. Please read this: https://docs.microsoft.com/en-us/cpp/build/vcpkg?view=msvc-160. They will save you tons of time trying to pull together different C++ libraries, potentially in the future. Now you might be wondering why we need two different package managers. So I will explain: scoop deals with applications, such as CMake and Python; vcpkg is a C++ dependency manager from Microsoft that goes together with Visual Studio, and it concerns with libraries that we can #include from our own code.

Now hopefully you are familiar with those package managers. Run the following commands (potentially in different directories depending on where you installed each package manager) to install what we need:

scoop install cmake
vcpkg --triplet x64-windows install openmesh
vcpkg --triplet x64-windows install opensubdiv
vcpkg --triplet x64-windows install pugixml
git clone --recursive https://github.com/JIPCAD/JIPCAD

vcpkg --triplet x64-windows install qt5-base qt5-3d (Update 12/21/2020: the most recent qt5 package, 5.15 as of 12/21, is no longer compatible with JIPCAD. Please read Qt installation below.)

Qt Installation​

Unfortunately, the more recent qt5 packages are not compatible with JIPCAD on Windows (Qt 5.15 is confirmed to not work, and I assume the newer ones, if any, may not work also). Vcpkg essentially forces users to install the most recent version of any package (there is a way to bypass this, but it is a bit of a headache), so we can't use vcpkg to install qt5. Thus, as a temporary solution, let's download Qt directly from the Qt website.

To fix this, please download Qt directly:

  1. Go to https://www.qt.io/download
  2. Click on "Go open source" , which leads to: https://www.qt.io/download-open-source?hsCtaTracking=9f6a2170-a938-42df-a8e2-a9f0b1d6cdce%7C6cb0de4f-9bb5-4778-ab02-bfb62735f3e5
  3. Scroll down and click "Download the Qt Online Installer"
  4. Download the installer and run it
  5. Follow the setup instructions, which will require you to create a Qt account if I recall correctly. When you to "Select Components" page, please select the following. We choose to install Qt 5.12.5 since it works w/ JIPCAD (this is a very important step):

very important

  1. Click next and complete installation. Qt should be ~40gb, so make sure you have enough storage space.
  2. Done, move on to compilation

Compile​

Open up the CMake GUI, and set it up like this:

Then click on "Add Entry" to add the following variables so that CMake can find all those libraries:

CMAKE_TOOLCHAIN_FILE = <Vcpkg dir>/scripts/buildsystems/vcpkg.cmake
CMAKE_INSTALL_PREFIX = <Qt cmake filepath>

For the Qt CMake filepath, in my case it is C:/Qt/5.12.5/msvc2017_64/lib/cmake to give you an example. This environment variable CMAKE_PREFIX_PATH is needed so that CMake knows where to look for Qt

Now you can click on "Configure" and "Generate" to generate a Visual Studio solution file and open it with Visual Studio. Then, click Build Solution, and a NOME3.exe should appear in the Build directory.

This an example of running a simple cube .nom instance after following the steps above:

Troubleshooting​

If you get an error involving ANTLR, first make sure the file path is correct. Then, copy paste this file https://github.com/JIPCAD/JIPCAD/blob/master/CMake/Modules/ExternalAntlr4Cpp.cmake into your ExternalAntlr4Cpp.cmake.

If you run into an issue with windeployqt.exe, make sure CMake was able to find it. Try providing the path manually.

Upon your first run of CMake, it may complain about Foundation does not contain a CMakeLists.txt file. This is because when you clone the repository, git does not by default clone all the submodules, so the Foundation subfolder is empty by default. You can either re-clone the repo with git clone --recursive or run git submodule update --init --recursive. If you have further questions, read the top portion of this short tutorial on git submodules - https://www.vogella.com/tutorials/GitSubmodules/article.html.

If you receive /bigobj error message due to exprtk.hpp, please follow the following instructions: https://docs.microsoft.com/en-us/previous-versions/visualstudio/visual-studio-2008/ms173499(v=vs.90)