1. Getting Set Up
2. Getting the Assignment Files
3. Testing Assignments
4. Working with Pre-Week-7 Assignments
5. Folder Structure

If you are working in the lab, you only need to install the Python requests module.

Note: If you are working at home and you need to submit but are unable to install this marking script you can always ssh into a lab machine and execute the script there.

The first thing you'll need is git.

You may well have this installed already. To check, open a terminal and type:

git --version

If you get a message about 'git' not being found, then you'll need to install it.

Python is a requirement for the marking script to function. On the computer you wish to use to upload your assignments you need to have OCaml installed, Python installed and the requests module installed for Python.

The lab machines already contain a copy of Python. To install 'requests' for the marking script to use, please run the following commands on the terminal. You can do the same on the virtual machine image.

git clone git://github.com/kennethreitz/requests.git
cd requests
python setup.py install --user

You can then safely delete the requests folder.

If you haven't done it already, you need to initialise your OPAM repository and upgrade it and install the missing dependencies.

opam init
opam upgrade
opam install quickcheck

You will also need to upgrade your environment, as indicated by OPAM:

eval `opam config env`

Haskell is another dependency, in particular the packages runhaskell and parsec. They can be installed using cabal which comes with the Haskell platform.

You can follow these steps to set up a virtual machine with (almost) everything pre-installed at home:

1. Download VirtualBox
2. Download the VirtualBox image

• This has Emacs, OCaml, Opam, Tuareg, Merlin, and utop. The password is focs.

3. Extract the zip folder, then open the file focs.vbox, which will then open up VirtualBox.
4. Select the focs machine in VirtualBox and then click Start at the top left. (Any warnings can usually be ignored).
5. Once Ubuntu has loaded, follow the other steps in this section.

Start a terminal session, and do the following steps:

The default installation of OCaml is too old. To access the new installation you need to type these commands every time you use the lab machines:

module load OCaml
module load OPAM
eval `opam config env`

Then, navigate to the folder in which you store your work files:

cd path/to/your/work/folder

• Next, we download the files:

  git clone https://github.com/Duta/focs-2015-16

• This will have created a folder called focs-2015-16:

  cd focs-2015-16

Inside focs-2015-16 will be files in the structure shown in the folder structure section.

Let's get the week 3's 1st exercise:

cd week-3/exercise-1

ocaml gen-skeleton.ml

This will create a new file in the exercise-1 folder called wk0ex1.ml.

This looks like this:

let zero = failwith "To do: Implement zero";;

This is a starting point for you to complete the exercise. Just replace the code with:

let zero x = 0;;

Note: Every week you'll be set new assignments.

To download them, make sure you're in the top-level folder (focs-2015-16), and type:

git pull

This will download any new assignments, making sure you're up to date.

You may also need to do this from time to time if we add or change test scripts.

In order for the marking script to upload your submission, you need to have an authentication token. This token will provide access to your canvas account, and should be treated as a password. Never share your access token with someone else. (It’s suggested best practice that you only make this token available for a day, and generate a new one every time you submit an assignment.)

• First, navigate to your profile settings on Canvas.

  https://birmingham.instructure.com/profile/settings

• Toward the bottom of this page, click to generate a new access token.

• Give the token a name under the "Purpose" entry box, select a suitable date (Generally the next day) and generate the token.

• You will be faced with a page that has your full token. Take a note of it as you’ll need it when running the testing script.

To test your assignments, you need to be in the week-n folder (e.g. week-0) in a terminal session, and run the testing script for the exercise you're working on.

As an example, this is how you'd test week 3's 1st exercise:

cd path/to/your/work/folder/focs-2015-16/week-3
python test_ex1.py

The output should be self-explanatory. If you pass the test, it will ask you to generate an access token for canvas, and will upload your file (along with a hash value used for detecting plagiarism) to canvas. See the instructions above about how to get the token. Once it is displayed in a Canvas window copy-and-paste it into the terminal window then hit return.

Note: The test script has been compiled with OCaml version 4.01.0. If you are using a different version of OCaml you may get this error:

Error: The file ex1_run.cmo is not a bytecode object file

You will need to use the same version of the compiler as in the lab (or as close as possible).

Downgrading the OCaml installation to 4.01.0 is very easy with OPAM:

opam switch 4.01.0
eval `opam config env`

Done!

Please don't try and upload your assignments to canvas manually! If you do, you'll get a mark of 0.

If everything works out correctly you should see no further output. If there are any errors please contact us immediately:

• Bertie Wheen wheen.b@gmail.com
• Kelsey McKenna kelseyjmckenna@gmail.com

The bench.cmi and bench.cmo files were changed in week 7, so if you wish to run the tests for assignments before week 7, then I suggest you clone a fresh copy of the repo, and then run reset the repository to the point before the files were updated. Here are the commands you should execute:

1. git clone https://github.com/duta/focs-2015-16
2. cd focs-2015-16
3. git reset --hard 834f9912cd88b8106f3c633da1efd968d0c3c211

And now you can work with pre-week-7 assignments as normal.

Alternatively, you can download the old bench.cmi and bench.cmo files here, and replace your current ones. Just make sure to copy and paste the new bench.cmi and bench.cmo files into your repo before you work with the week-7 and week-8 assignments.

Contains assignments for the UoB EFC module, 2015-16.

focs-2015-16
|-- README.md
|-- StripComments.hs
|-- bench.cmi
|-- bench.cmo
|-- prepare_env.csh
|-- test.py
|-- validator.py
`-- week-3
    |-- exercise-1
    |   `-- gen-skeleton.ml
    |-- exercise-2
    |   `-- gen-skeleton.ml
    `-- exercise-3
        `-- gen-skeleton.ml