universal-starter

Super simple repo to get started with the Universal library

Once you use this template to create your own development repository, you will need to adjust the status badges below to point to your repo.

System	Status	More information
FOSSA Status		Open-source license dependency scanner Stillwater Universal
GitHub Actions		Latest Linux/MacOS/Windows builds and regression tests

How to build

This repo uses git submodules. The first step after pulling the repository is to configure the submodules:

> git submodule init && git submodule update

After that, the repo is ready to be build:

> mkdir build
> cd build
> cmake ..
> make

This will build the libraries, the CLI command projects, and the tests in test/tests.

When using VSCode, the repository contains a devcontainer spec in the directory $REPO_ROOT/.devcontainer.

The default container provides a build environment based on Clang15:

{
	"image": "stillwater/builders:clang15builder"
}

There is a set of builders that can be used that contain specific compilers. Other environments are:

gcc9builder
gcc10builder
gcc11builder
gcc12builder
clang11builder
clang12builder
clang13builder
clang14builder
clang15builder

If you want to change your development container, simply replace the json with the container of your choice.

You can also build natively. The .gitignore of this repo filters out the following directories:

build/
build_msvc/
build_gcc/
build_clang/

You can use these build directories to organize your native and specific build containers so that they can run concurrently. For example, you can use the build/ directory to hold native builds, and build_gcc/ directory to hold the default build container builds.

Install command line tools, libraries, and include files

To install the command line tools for ease of use, issue the install target:

> make install

This command will populate the $REPO_ROOT/bin, $REPO_ROOT/lib, and $REPO_ROOT/include directories, where $REPO_ROOT represents the directory path of the mixed-precision-ir repository clone.

If you are on a Linux or MacOS system, you can add the bin directory to your path to pick up the command line tools:

> export PATH=$PATH:$REPO_ROOT/bin

For Windows, use the environment variable editor to do the same.

Streamlining the Build

To just build the projects in universal-starter and ignore build targets in Universal and MTL4, use:

> cmake -DBUILD_DEMONSTRATION=OFF -DENABLE_TESTS=OFF ..

Updating the submodules

If you want to update the submodules to the latest version of the upstream repos, issue this command:

> git submodule update --remote --merge

Project structure

The following figure shows the project structure of this repository: