Skip to content

Folder Structure

The folders in student projects should strictly follow the structure of the folders in this repository. The main folders are four assignment folder (corresponding to each assignment) and one folder for final deliverables of your project. In general, the process sub-folders include all the necessary code, notebook, files, and models that you have used to achieve the final product of that assignment. It also includes document that represent the process of the assignment such as flowcharts, diagrams and pseudo-codes. The product sub-folder sh

Here is run down of the overall structure:

  • A1_Planning
    • Process
    • Product
  • A2_Configuring
    • Process
    • Product
  • A3_Massing
    • Process
    • Product
  • A4_Forming
    • Process
    • Product
  • Final_Deliverables

    Here you will include all the final deliverables of your project.

  • docs

    Here you will write and edit the source of your documentation in MarkDown. An example is included in the template to help you begin documenting your project.

  • site

    you should leave this directory empty. It will be filled by automatic documentation generator MkDocs