VCalcBase

The base cmake setup for VCalc assignment.

Author: Braedy Kuzma (braedy@ualberta.ca)
Updated by: Deric Cheung (dacheung@ualberta.ca) Updated by: Quinn Pham (qpham@ualberta.ca)

Usage

Installing MLIR

In this assignment and your final project you will be working with MLIR and LLVM. Due to the complex nature (and size) of the project we did not want to include MLIR as a subproject. Therefore, there is some additional setup required to get your build up and running.

On a personal machine

1. Follow the instructions on the setup page for your machine.

On university machines

You won't be building MLIR on the university machines: AICT wouldn't be very happy with you. Instead, we are providing a RELEASE build available for everyone.

1. Follow the instructions on the setup page for the CS computers and MLIR/LLVM will be available to you.

Building

Linux

1. Install git, java (only the runtime is necessary), and cmake (>= v3.20).
   • Until now, cmake has found the dependencies without issues. If you encounter an issue, let a TA know and we can fix it.
2. Make a directory that you intend to build the project in and change into that directory.
3. Run cmake <path-to-VCalc-Base>.
4. Run make.
5. Done.

Pulling in upstream changes

If there are updates to your assignment you can retrieve them using the instructions here.

1. Add the upstream as a remote using git remote add upstream <clone-link>.
2. Fetch updates from the upstream using git fetch upstream
3. Merge the updates into a local branch using git merge <local branch> upstream/<upstream branch>. Usually both branches are master.
4. Make sure that everything builds before committing to your personal master! It's much easier to try again if you can make a fresh clone without the merge!

Once the remote has been added, future updates are simply the fetch and merge steps.