Editing User:Mitchdraft/GSoC15/Proposal

From BRL-CAD

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision Your text
Line 1: Line 1:
=Application Withdrawn=
 
'''Thank you for you consideration, however after more thought, I realized I will not be able to commit the time required for this project. I will leave this page here for reference, but I will not be participating in GSoC15. I look forward to participating in the BRL-CAD/OpenSCAD community in other ways.'''
 
  
  
Line 9: Line 7:
 
*'''IRC username''': mitch
 
*'''IRC username''': mitch
 
*'''Contact Number''': 508-838-1960
 
*'''Contact Number''': 508-838-1960
*'''Project Activity Log''': https://github.com/mitchdraft/scaddergories/wiki/Project-Status-Monitor
+
*'''Blog''': https://github.com/mitchdraft/scaddergories/wiki
 
*'''Background Information'''
 
*'''Background Information'''
 
**Candidate for Master's of Science in Mechanical Engineering at Georgia Tech, currently conducting thesis in improving CAD interfaces
 
**Candidate for Master's of Science in Mechanical Engineering at Georgia Tech, currently conducting thesis in improving CAD interfaces
 
**Bachelors of Science in Mechanical Engineering from MIT, 2011
 
**Bachelors of Science in Mechanical Engineering from MIT, 2011
**4 Years (ongoing) of mechanical engineering experience as a product development engineer (practicing user of Solidworks and other CAD tools in the engineering field)
+
**4 Years (and counting) of mechanical engineering experience as a product development engineer (practicing user of Solidworks and other CAD tools in the engineering field)
 
**Budding software developer - the tools in a software developer's toolbox are extremely valuable in all aspects of life, I am eagerly integrating these tools into my workflow. I have extensive experience in Matlab/Scilab, Processing/OpenFrameworks, and arduino. I have a good understanding of programming principles and am not intimidated by new languages or development environments.
 
**Budding software developer - the tools in a software developer's toolbox are extremely valuable in all aspects of life, I am eagerly integrating these tools into my workflow. I have extensive experience in Matlab/Scilab, Processing/OpenFrameworks, and arduino. I have a good understanding of programming principles and am not intimidated by new languages or development environments.
**In a graduate CAD class I prototyped a method for automatically positioning components in an assembly using a simulated annealing algorithm. To do this I created a simple voxel-based solid modeling environment in Matlab. You can see a demo [https://www.youtube.com/watch?v=L0L1OKj12I4 here]. (If I were to do it again, I would have used OpenSCAD + improved coding skills and gotten a bit further!).
 
  
 
=Project Information: OpenSCAD Standard Library=
 
=Project Information: OpenSCAD Standard Library=
 
'''Title:''' OpenSCAD Standard Library
 
'''Title:''' OpenSCAD Standard Library
  
'''Introduction'''
+
'''Introduction:'''
  
 
The OpenSCAD Standard Library requires three main things:  
 
The OpenSCAD Standard Library requires three main things:  
Line 30: Line 27:
 
#Production of new orthogonal content.
 
#Production of new orthogonal content.
  
==Project Description==
+
==Project Description:==
 
+
===From OpenSCAD===
===Brief===
 
'''From OpenSCAD'''
 
  
 
OpenSCAD comes with a number of basic built-in primitives and operators. When creating 3D designs it would be useful to have access to a library of commonly used parts and techniques. One way of improving the current situation would be to define an OpenSCAD Standard Library. This would include well-defined, orthogonal, well-tested and well-documented components. All components would be user-space OpenSCAD code.
 
OpenSCAD comes with a number of basic built-in primitives and operators. When creating 3D designs it would be useful to have access to a library of commonly used parts and techniques. One way of improving the current situation would be to define an OpenSCAD Standard Library. This would include well-defined, orthogonal, well-tested and well-documented components. All components would be user-space OpenSCAD code.
Line 41: Line 36:
 
Difficulty: Medium. The main challenge is to have good enough structure, documentation and testing in order to have trustworthy and useful components.
 
Difficulty: Medium. The main challenge is to have good enough structure, documentation and testing in order to have trustworthy and useful components.
  
 +
===Customized and augmented by student:===
  
===Detailed===
+
This would include: identifying a base set of mechanical components, identifying variants in an organized hierarchy/network, establishing a module format and documentation style, seeding the framework with detailed representative modules, generating several instances of parts and assemblies to serve as usage examples, documenting how to contribute and soliciting/coaching community involvement.
'''As interpreted by the student'''
 
 
 
There are many ways to approach this project. For an actionable construct, I identify three main tasks in this project:
 
#Integrate existing libraries
 
#Include complete fastener kit
 
#Abstract the library framework
 
  
The first two identified tasks serve clear and immediate needs. These will constitute the bulk of my work. The third task provides the opportunity to capture insights developed along the way and recommend a path forward.
+
Documentation will be very important. At minimum, I would have a photo of a rendered part for each module, these photos linked to source code and "neighboring" parts. A key challenge will be making a framework for sorting and finding parts.
Please see the Tasks section for details.
 
  
==Why I am interested in this project and why I am the best person to do it==
+
==Why I am interested in this project and why I am the best person to do it:==
===I have a professional interest in this project===
+
===I have a professional interest in this project:===
  
 
In my work as a product development engineer at a consulting company we often start projects by doing an orthogonal technology review. It's often one of the most important parts of the project, setting up a framework for analysis. I have gone through the process many times, mentored by industry experts. I thoroughly enjoy and have become adept at features identification, analysis, and implementation. I would like to apply this process to creating an OpenSCAD parts library. I have seen the way good frameworks can enhance productivity and creativity. I know a library like this will be useful to my colleagues and the growing maker community.
 
In my work as a product development engineer at a consulting company we often start projects by doing an orthogonal technology review. It's often one of the most important parts of the project, setting up a framework for analysis. I have gone through the process many times, mentored by industry experts. I thoroughly enjoy and have become adept at features identification, analysis, and implementation. I would like to apply this process to creating an OpenSCAD parts library. I have seen the way good frameworks can enhance productivity and creativity. I know a library like this will be useful to my colleagues and the growing maker community.
  
===I have an academic interest in this project===
+
===I have an academic interest in this project:===
  
 
In my research as a master's candidate under Professor Rosen at Georgia Tech I am working to improve CAD funcationality and useability. My specific thesis topic is establishing a framework for and evaluating the utility of Human-Computer Interface (HCI) devices for CAD and other technical, creative work. This work involves developing a CAD environment to represent common practice user interactions and test new interactions and features enabled by the integration of software and existing and new interface devices. Professor Rosen is an authority on the topic of modern CAD systems. He has been a great mentor, identifying the state of the art and avenues towards the improvement of CAD systems, focusing the work towards areas of maximum benefit. In this project I have the opportunity to integrate insights of experts, community members, and an analytical framework into a fully functional open source platform.
 
In my research as a master's candidate under Professor Rosen at Georgia Tech I am working to improve CAD funcationality and useability. My specific thesis topic is establishing a framework for and evaluating the utility of Human-Computer Interface (HCI) devices for CAD and other technical, creative work. This work involves developing a CAD environment to represent common practice user interactions and test new interactions and features enabled by the integration of software and existing and new interface devices. Professor Rosen is an authority on the topic of modern CAD systems. He has been a great mentor, identifying the state of the art and avenues towards the improvement of CAD systems, focusing the work towards areas of maximum benefit. In this project I have the opportunity to integrate insights of experts, community members, and an analytical framework into a fully functional open source platform.
  
===I have a personal interest in this project===
+
===I have a personal interest in this project:===
  
 
My personal objective is to help people identify and achieve their goals. I believe that Computer Aided Design (including 3D geometry modeling and many other computer-facilitated organization and evaluation systems) is the best tool for expressing the imagination. I enthusiastically believe that it is true that "if you can dream it you can do it." And since dreaming is difficult and important I want to do whatever I can to help people realize their personal simple and fantastic dreams.
 
My personal objective is to help people identify and achieve their goals. I believe that Computer Aided Design (including 3D geometry modeling and many other computer-facilitated organization and evaluation systems) is the best tool for expressing the imagination. I enthusiastically believe that it is true that "if you can dream it you can do it." And since dreaming is difficult and important I want to do whatever I can to help people realize their personal simple and fantastic dreams.
  
 
==Tasks==
 
==Tasks==
 
+
There are three main tasks in this project:
 +
#Integrate Existing Libraries
 +
#Include complete fastener kit
 +
#Abstract the library framework
  
 
=== Integrate Existing Libraries===
 
=== Integrate Existing Libraries===
Line 84: Line 76:
 
**Processing - to make the library interface which will output a text file for rendering by OpenSCAD.
 
**Processing - to make the library interface which will output a text file for rendering by OpenSCAD.
 
**OpenSCAD - for modifying existing MCAD code
 
**OpenSCAD - for modifying existing MCAD code
 
*Reference technologies:
 
**PHP Composer
 
**Git hub
 
**Ubuntu package manager
 
**Solidworks parts libraries
 
**Thingiverse
 
  
 
*Expected time:
 
*Expected time:
Line 96: Line 81:
  
  
===Include complete fastener kit===
+
====Include complete fastener kit====
  
 
Fasteners are a key part to most mechanical designs. Mechanical engineers spend a considerable amount of time selecting and integrating fasteners into designs. This can significantly impede the prototyping process. Fortunately, fasteners are well standardized and cataloged, so OpenSCAD is a perfect platform for automated fastener selection and integration.
 
Fasteners are a key part to most mechanical designs. Mechanical engineers spend a considerable amount of time selecting and integrating fasteners into designs. This can significantly impede the prototyping process. Fortunately, fasteners are well standardized and cataloged, so OpenSCAD is a perfect platform for automated fastener selection and integration.
Line 118: Line 103:
 
**Data mining (TBD) - for collecting hardware parameters
 
**Data mining (TBD) - for collecting hardware parameters
 
**TBD - for converting available, verbose, CAD files to .scad hardware representations
 
**TBD - for converting available, verbose, CAD files to .scad hardware representations
 
*Reference technologies:
 
**Machinist's Handbook
 
**Fastener standards
 
**Strength of materials
 
**McMaster-Carr web catalog
 
**SDP-SI web catalog
 
**Data mining
 
**Least squares and other fitting algorithms (for extracting .scad representations from IGES and other verbose solid models)
 
**Interference detection algorithms
 
  
 
*Expected time:
 
*Expected time:
 
**6 weeks
 
**6 weeks
  
===Abstract the library framework===
+
====Abstract the library framework====
  
 
There is a good amount of design work to be done to generate an effective standard library. A good way to approach this type of project is with iterative prototypes. I view the current MCAD library as a strong initial prototype. I hope to improve MCAD with my contribution but I would be naive to believe that the best library can be produced in a three month project and I would be negligent to discard lessons learned. I intend to sketch-out/mock-up a larger framework for the standard library based on my experience developing the features of Tasks 1 and 2.
 
There is a good amount of design work to be done to generate an effective standard library. A good way to approach this type of project is with iterative prototypes. I view the current MCAD library as a strong initial prototype. I hope to improve MCAD with my contribution but I would be naive to believe that the best library can be produced in a three month project and I would be negligent to discard lessons learned. I intend to sketch-out/mock-up a larger framework for the standard library based on my experience developing the features of Tasks 1 and 2.
  
I will conduct a more thorough evaluation, but at first pass, some components which I think are important to have well represented in the standard library include:
 
*Stock material in standard dimensions (thickness, profile)
 
*Standard electronics components (non-board mounted)
 
*Fixtures
 
*Chassis
 
 
 
Some features which would be very useful in the standard parts library include:
 
*Tolerance representation
 
*Annotation
 
*Part-specific insertion calls (some parts need to be on the surface on an assembly, some can be left inside)
 
*Personal inventory
 
*Personal library creation or filtering
 
*Domain-specific filters
 
*Vendor-specific parts names and prices
 
  
 
*Deliverables:
 
*Deliverables:
 
**''Integrate and abstract lessons learned to a larger library framework draft.''
 
**''Integrate and abstract lessons learned to a larger library framework draft.''
**''Identify at least 10 categories of parts which should be included in future versions of the standard library''
 
**''Implement at least 5 additional part categories''
 
**''Identify and justify at least 5 desirable features of a future library.''
 
**''Prototype two future library features.''
 
  
 
*Languages used:
 
*Languages used:
 
**Processing - for extending the Task 1 & 2 library interface.
 
**Processing - for extending the Task 1 & 2 library interface.
 
**OpenSCAD - for generating seed models for the abstracted library framework.
 
**OpenSCAD - for generating seed models for the abstracted library framework.
 
*Reference technologies:
 
**Qt language interface features (the tool used for OpenSCAD's interface, prototypes should be designed with awareness of Qt's capabilities)
 
  
 
*Expected time:
 
*Expected time:
 
**2 weeks
 
**2 weeks
  
==Schedule/Milestones==
+
=Reqs=
*Weeks 1-4
+
*Personal Information
**Study MCAD library, extract all functions and parameters
+
**Name
**Develop interactive parts selection and customization tool
+
**E-mail address
*Weeks 5-10
+
**IRC username
**Develop fastener selection tool
+
**Brief background info
**Develop fastener assembly insertion functions
+
**(optional) Link to resumé
**Establish database/calling functions for all common hardware
+
*Project Information
*Weeks 11-12
+
**Project Title
**Seed library with additional parts
+
**Brief project summary (<500 words)
**Create future library feature prototypes
+
**Detailed project description (>500 words)
**Document additional opportunities for library expansion
+
**Links to any code or algorithms you intend to use
 
+
**Deliverables (specific, measurable goals)
=Availability=
+
**Development schedule
*I work a full time job but will still be able to commit 40-45 hours per week to this project. This project is important to me. In one sense, my work as a mechanical engineer is the ultimate user study.
+
***List at least three milestones
*I can be reached online or by phone 5-9 AM or 5-11 PM EST.
+
**Describe time availability (40+ hours/week assumed)
*I will spend one week during July at the beach. During this time I'll reflect on the bigger problems (haha). I can route any lost time to the weekends.
+
***List all commitments (e.g., exams, vacations)
 +
**(optional) Why us?
 +
**(optional) Why you?
 +
**(optional) Anything else?

Please note that all contributions to BRL-CAD may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see BRL-CAD:Copyrights for details). Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel Editing help (opens in new window)