Lab X: Lab Report Sample

WeeSan Lee <weesan@cs.ucr.edu>

Objective

This report is to explain the steps on how to submit a lab report via Moodle.

Introduction

To facilitate the lab reports submission and the grading process for the TAs, the following procedures are created, of which all students are expected to follow.

Procedures

Before writing your lab report, create a directory based on the lab number. Then create and edit index.html inside that directory. For example: 
  $ mkdir lab1
  $ cd lab1
  $ vi index.html
All outputs and screenshots are supposed to be stored inside the same directory.

Once you are done with your report, before submitting, you need to tar and gzip it. For example: 

  $ cd ..
  $ tar cvf lab1.tar lab1
  $ gzip -9 lab1.tar
A file named lab1.tar.gz will be created. Then submit the file via Moodle.

Conclusion

We recommend all students to use a consistent naming convention to name the directory of each lab, and then tar and gzip the whole directory. Not only does it simplify the process of report submission, but also it makes things easier for the students to deploy their reports on their personal homepage in the future.

Further Reading

Moodle is a free, web-based Course Management System. For more information, see here.

tar and gzip are commands and tools from GNU. For more information, please reference:

Glossary

tar
A GNU program to create archives for file and directories into a single file.
gzip
A GNU program developed to replace compress.

Questions

  1. What is the big deal using a consistent naming convention for each lab?
    It makes each lab submission a lot easier for the students and the grading process easier for the TAs.
  2. What if a student did not follow the convention?
    The student will be marked down for that particular lab report.