How to Build Gulliver

Note

Make sure you clone the latest version of Gulliver’s main branch from Github https://github.com/sandialabs/Gulliver.git.

C# Code

Setup Your C# Environment

Gulliver is built with C#, if you want to build Gulliver you’ll want to set yourself up to build C# code.

  1. Install the .NET SDK appropriate for your environment.

  2. Consider installing Visual Studio and/or Visual Studio Code.

  3. Everything you want to do here on out can be done with dotnet command line tool.

    • To build

      dotnet build path\to\gulliver\src\Gulliver.sln

    • To test

      dotnet test path\to\gulliver\src\Gulliver.Tests\Gulliver.Tests.csproj

    • To package

      dotnet pack path\to\gulliver\src\Gulliver\Gulliver.csproj

Build The Documentation

First Things First

Note

Before you can run, first you must walk. Likewise, before you can build docs fist you must do some Python stuff.

The documentation relies on Sphinx and Python and a number of Python packages.

  1. Install Python 3.7+

  2. Install Sphinx 2.2.0+ via the Python package manager pip

    pip install sphinx

  3. Install the Sphinx RTD Theme via pip

    pip install sphinx_rtd_theme

Build

Once you have all the perquisites in place building the documentation, as HTML [1], is as simple as locating the make.bat in the Gulliver docs folder. Then simply execute

path\to\gulliver\docs\make.bat html

Once complete the documentation will be present in the _build sub folder of docs.

footnotes