Getting Started in Windows

Lisa Malenfant edited this page May 16, 2018 · 19 revisions

Prerequisites

  • We assume you have Git installed locally (https://git-scm.com/) or any application like SourceTree (https://www.sourcetreeapp.com) for visualizing Git repositories.
  • Create a GitHub account if you would like to contribute to the project, click Sign up at the top of this page.
  • The main solution Vts.sln contains a .NET Standard 2.0 project so you will need Visual Studio 2017 and all the latest updates and service packs. If .NET Standard 2.0 is still not recognized install the .NET Core 2.0 SDK
  • If you have an older version of Visual Studio there is a solution file that will omit the .NET Standard and .NET Core projects (Vts-VS2010-2015-Compatible.sln)
  • The solution requires the .NET Framework 2.6.1 if you do not have a version of Visual Studio including this framework or to build without Visual Studio, download the following:

Additional Resources

Proud to use:
ReSharper

Getting the Source Code

Clone the source code from GitHub:

  • Create a new folder on your machine. Or if you are using an existing folder make sure there is no folder named Vts within that folder (This is the name it will use for the Vts repository).
  • Right-click on the folder and select Git Bash Here

GitBash

  • Type git clone https://github.com/VirtualPhotonics/VTS.git

GitBash

  • Once the files are cloned, open the solution file in Visual Studio <clone_root>/Vts/src/Vts.sln
  • For intructions on building the software in Visual Studio go to Compile and run the VTS
  • It is possible to build the solution without Visual Studio

Clone branch code from GitHub:

  • Type git clone -b branchName --single-branch https://github.com/VirtualPhotonics/VTS.git
  • This will clone only the branch. Periodically the master trunk is merged into each of our branches, however, note that updates to the master trunk will not appear in the branch until this merge occurs.

Build the Monte Carlo Command Line (MCCL) and the VTS Matlab packages:

  • In File Explorer, navigate to the vts folder. Right click BuildTextRelease.bat->Run as administrator. This will build the source code and run unit tests. The unit tests use Matlab, if this are not installed on your computer, the batch file will continue (some warning windows might appear). Two zip files will be created in the root of the ../vts/build/ folder: 1) MC_vxx.zip and (MCCL) 2) VTS_MATLAB_vxx.zip (VTS Matlab). These are the same zip files that we distribute in the downloads section. For instructions on how to use the software click MCCL and MATLAB.