-
Notifications
You must be signed in to change notification settings - Fork 2
/
index.html
138 lines (114 loc) · 7.35 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
<!DOCTYPE html>
<html>
<head>
<meta charset='utf-8'>
<meta http-equiv="X-UA-Compatible" content="chrome=1">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
<link href='https://fonts.googleapis.com/css?family=Architects+Daughter' rel='stylesheet' type='text/css'>
<link rel="stylesheet" type="text/css" href="stylesheets/stylesheet.css" media="screen">
<link rel="stylesheet" type="text/css" href="stylesheets/pygment_trac.css" media="screen">
<link rel="stylesheet" type="text/css" href="stylesheets/print.css" media="print">
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<title>NapCAD</title>
</head>
<body>
<header>
<div class="inner">
<h1>NapCAD</h1>
<h2>NapCAD is an openCV-based image to STL converter, designed to model folded forms from a sketch of the geometric net.</h2>
<a href="https://github.com/ctada/napCAD" class="button"><small>View project on</small> GitHub</a>
</div>
</header>
<div id="content-wrapper">
<div class="inner clearfix">
<section id="main-content">
<h3>
<a id="welcome-to-github-pages" class="anchor" href="#welcome-to-github-pages" aria-hidden="true"><span class="octicon octicon-link"></span></a>Getting Started</h3>
<p>Click to view an overview of our project through our final poster <a href="SoftDes_Final_Poster.pdf">here</a></p>
<p>Let's get straight to it! Make sure you have the <a href="#proj-libs" >right</a> libraries installed. Then, clone the repo and run the program:</p>
<pre><code>$ cd your_repo_root
$ git clone https://github.com/ctada/napCAD.git
$ cd napCad
$ python gui_test.py
</code></pre>
<p>At this point, the following screen should pop up. Hold up your drawn geometric net to your webcam, and click "Preview 3D Model". The green lines on screen represent the edges that the program "sees" in your drawing. After previewing, you can save the 3D render and STL file, or try a new sketch.</p>
<img src="images/demo_screenshot.png" title="NapCAD Initial Screenshot" alt="NapCAD Cube Screenshot" class="padded"/>
<p>The result will look something like the following. Note that the scale of the 3D render may be skewed; the coordinate values on the axes should still be accurate, however. Click, hold, and drag on the figure to view the folded form from multiple perspectives. In the lower left, a toolbar also provides additional options, such as saving the figure (NOTE: This is NOT the same as saving the STL file).</p>
<img src="images/dl_screenshot.png" title="NapCAD Download Screenshot" alt="NapCAD CubeSTL Screenshot" class="padded"/>
<h3>
<a id="proj-libs" class="anchor" href="#proj-libs" aria-hidden="true"><span class="octicon octicon-link"></span></a>Libraries and Dependencies</h3>
<p>In writing the code, the following libraries were used:</p>
<p>Auto-installed:
<ul>
<li>Tkinter</li>
<li>Numpy</li>
<li>Math</li>
<li>Collections</li>
<li>Stlwriter (comes with repo)</li>
</ul>
</p>
<p>Will need to be installed:
<ul>
<li>OpenCV</li>
<li>Scipy</li>
<li>Pillow</li>
<li>Matplotlib</li>
</ul>
</p>
<p>To install these libraries, enter the following into command line. NOTE: This assumes a Debian/ Ubuntu operating system.</p>
<pre><code>
$ sudo apt-get install python-numpy python-scipy python-matplotlib
$ sudo pip install Pillow
$ sudo apt-get install python-imaging-tk
</code></pre>
<p>A couple things in case you run into issues:</p>
<p> 1. If you need to install dependencies for the above libraries (in this example, python-matplotlib), try
<pre><code>
sudo apt-get build-dep python-matplotlib
</code></pre>
2. The following error may show up when running code that contains OpenCV:
<pre><code>ValueError: too many values to unpack</pre></code> If this happens, change the beginning of line 74 in napCAD.py and line 30 in read_box_image.py from “(cnts,_) ” to “_,cnts, _” and the code will run. We believe this is an issue with OpenCV versions, but we're still working on confirming that hypothesis.
</p>
<h3>
<a id="proj-docs" class="anchor" href="#proj-docs" aria-hidden="true"><span class="octicon octicon-link"></span></a>Project Documentation</h3>
<p>Documentation for each module is below:
<ul>
<li><a href="Docs/napCAD.html" class="user-mention">napCAD (main) module</a></li>
<li><a href="Docs/read_box_image.html" class="user-mention">read_box_image module</a></li>
<li><a href="Docs/face_finder.html" class="user-mention">facefinder module</a></li>
<li><a href="Docs/folding_v2.html" class="user-mention">folding module</a></li>
</ul>
<p>Project management documents that track progress over the course of the project are below:</p>
<ul>
<li><a href="https://docs.google.com/document/d/1METP5y3Y44aH6qP9oOWXrmx591cr2wFIeA-wFuPJdTo/edit" class="user-mention">Project Proposal</a></li>
<li><a href="https://docs.google.com/document/d/1sashaslikqVJYPo4Gxy6Q3mdbeaG-jh5iC-lHgOn0o8/edit?usp=sharing" class="user-mention">Design Review Framing Document</a></li>
<li><a href="https://docs.google.com/document/d/1q6bdR8IxR_4XF1yKjgJJIxguqUbFQk0GmoPJXzmSoYk/edit?usp=sharing">Design Review Reflection</a></li>
<li><a href="https://docs.google.com/document/d/14HKfEM_XHwM-tewucDM9E0tyuydTLF2RgIu3GJZcpAQ/edit?usp=sharing">Code Review Framing Document</a></li>
<li><a href="https://docs.google.com/document/d/1Igzj8OKv6TrQI-QBCjdoh1X4b3vYS8eJOj9_NiglUjk/edit?usp=sharing">Code Review Reflection</a></li>
<li><a href="https://drive.google.com/file/d/0B9O1OugmZywzcFdZalZ5MFpmcmM/view?usp=sharing">Final Poster</a></li>
</ul>
<h3>
<a id="authors-and-contributors" class="anchor" href="#authors-and-contributors" aria-hidden="true"><span class="octicon octicon-link"></span></a>Authors and Contributors</h3>
<p>This project was created as part of the Software Design course at Olin College, Spring 2015. The team consists of Kathryn Hite (<a href="https://github.com/kghite" class="user-mention">@kghite</a>), Shivali Chandra (<a href="https://github.com/skchandra" class="user-mention">@skchandra</a>), Caleb Kissel (<a href="https://github.com/ckissel" class="user-mention">@ckissel</a>), and Celine Ta (<a href="https://github.com/ctada" class="user-mention">@ctada</a>).</p>
<h3>
<a id="support-or-contact" class="anchor" href="#support-or-contact" aria-hidden="true"><span class="octicon octicon-link"></span></a>Support or Contact</h3>
<p>Having trouble with Pages? Check out the documentation at <a href="https://help.github.com/pages">https://help.github.com/pages</a> or contact <a href="mailto:support@github.com">support@github.com</a> and we’ll help you sort it out.</p>
</section>
<aside id="sidebar">
<a href="https://github.com/ctada/napCAD/zipball/master" class="button">
<small>Download</small>
.zip file
</a>
<a href="https://github.com/ctada/napCAD/tarball/master" class="button">
<small>Download</small>
.tar.gz file
</a>
<p class="repo-owner"><a href="https://github.com/ctada/napCAD"></a> is maintained by <a href="https://github.com/ctada">ctada</a>.</p>
<p>This page was generated by <a href="https://pages.github.com">GitHub Pages</a> using the Architect theme by <a href="https://twitter.com/jasonlong">Jason Long</a>.</p>
</aside>
</div>
</div>
</body>
</html>