How to Build Gulliver¶
Make sure you clone the latest version of Gulliver’s master branch from Github https://github.com/sandialabs/Gulliver.git.
Building with psake¶
Gulliver uses psake, a build automation tool written in PowerShell, to aid in the build, but it isn’t explicitly necessary. To use psake follow the “How to get started” guide on their site, adding it to your path.
If you’d rather not use psake jump ahead to see the manual way of doing things.
The psake tasks are defined in the
pasake.ps1 PowerShell script in the project root directory.
If you’re using Visual Studio Code, and if you’re not you should be, the psake tasks are available in the Task Explorer. The tasks are referenced in the
.vscode\tasks.json in the root directly of Gulliver.
Before attempting to run any of the psake tasks make sure you have the appropriate prerequisites in place.
The tasks of most concern are as follows:
Cleans the C# portion of the project by removing the various
Cleans and builds the C# source.
Runs the Gulliver unit tests.
Builds the Sphinx Documentation as HTML.
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.
Install the .NET Core SDK appropriate for your environment.
Everything you want to do here on out can be done with dotnet command line tool.
dotnet build path\to\gulliver\src\Gulliver.sln
dotnet test path\to\gulliver\src\Gulliver.Tests\Gulliver.Tests.csproj
dotnet pack path\to\gulliver\src\Gulliver\Gulliver.csproj
Build The Documentation¶
First Things First¶
Before you can run, first you must walk. Likewise, before you can build docs fist you must do some Python stuff.
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
Once complete the documentation will be present in the
_build sub folder of