Code Monkey home page Code Monkey logo

spatial_computing_project_template's Introduction

Spatial Computing Project Template

This is a project template for Spatial Computing Students. Students shall fork this repository and use it as the basis of their project. Mid-term and Final submission is expected through pull GitHub.

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

Guidelines

  • File Size: No file bigger than 50mb is recommended. No file bigger than 100mb is allowed.
  • Duplicates: Do NOT include duplicates in your files.
  • Naming Convention: Avoid using special characters or spaces in file and folder names. Instead, use "_" to separate words in the names.
  • Video and Animation files should not be included the repository. They should be uploaded to online video services (YouTube, Vimeo, etc). You should embed those video link in your documentation. (GIF files are allowed in your repo)
  • Geometric Models (.3dm, .obj, etc) should be compressed before being added to repository.

spatial_computing_project_template's People

Contributors

shervinazadi avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.