-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathoverview.html
More file actions
852 lines (784 loc) · 35.9 KB
/
Copy pathoverview.html
File metadata and controls
852 lines (784 loc) · 35.9 KB
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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Guide — Introductory Python</title>
<link href="../_static/css/theme.css" rel="stylesheet">
<link href="../_static/css/index.ff1ffe594081f20da1ef19478df9384b.css" rel="stylesheet">
<link rel="stylesheet"
href="../_static/vendor/fontawesome/5.13.0/css/all.min.css">
<link rel="preload" as="font" type="font/woff2" crossorigin
href="../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2">
<link rel="preload" as="font" type="font/woff2" crossorigin
href="../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2">
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/sphinx-book-theme.css?digest=c3fdc42140077d1ad13ad2f1588a4309" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/togglebutton.css" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="../_static/mystnb.css" />
<link rel="stylesheet" type="text/css" href="../_static/sphinx-thebe.css" />
<link rel="stylesheet" type="text/css" href="../_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css" />
<link rel="stylesheet" type="text/css" href="../_static/panels-variables.06eb56fa6e07937060861dad626602ad.css" />
<link rel="preload" as="script" href="../_static/js/index.be7d3bbb2ef33a8344ce.js">
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/clipboard.min.js"></script>
<script src="../_static/copybutton.js"></script>
<script >let toggleHintShow = 'Click to show';</script>
<script >let toggleHintHide = 'Click to hide';</script>
<script >let toggleOpenOnPrint = 'true';</script>
<script src="../_static/togglebutton.js"></script>
<script >var togglebuttonSelector = '.toggle, .admonition.dropdown, .tag_hide_input div.cell_input, .tag_hide-input div.cell_input, .tag_hide_output div.cell_output, .tag_hide-output div.cell_output, .tag_hide_cell.cell, .tag_hide-cell.cell';</script>
<script src="../_static/sphinx-book-theme.d59cb220de22ca1c485ebbdc042f0030.js"></script>
<script async="async" src="https://unpkg.com/thebe@0.5.1/lib/index.js"></script>
<script >
const thebe_selector = ".thebe"
const thebe_selector_input = "pre"
const thebe_selector_output = ".output"
</script>
<script async="async" src="../_static/sphinx-thebe.js"></script>
<link rel="shortcut icon" href="../_static/logo.png"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="FAQ" href="faq.html" />
<link rel="prev" title="Assignment 4: Artificial Agents" href="../assignments/D4-ArtificialAgents.html" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="docsearch:language" content="None">
<!-- Google Analytics -->
</head>
<body data-spy="scroll" data-target="#bd-toc-nav" data-offset="80">
<div class="container-fluid" id="banner"></div>
<div class="container-xl">
<div class="row">
<div class="col-12 col-md-3 bd-sidebar site-navigation show" id="site-navigation">
<div class="navbar-brand-box">
<a class="navbar-brand text-wrap" href="../index.html">
<!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 -->
<img src="../_static/logo.png" class="logo" alt="logo">
<h1 class="site-logo" id="site-title">Introductory Python</h1>
</a>
</div><form class="bd-search d-flex align-items-center" action="../search.html" method="get">
<i class="icon fas fa-search"></i>
<input type="search" class="form-control" name="q" id="search-input" placeholder="Search this book..." aria-label="Search this book..." autocomplete="off" >
</form><nav class="bd-links" id="bd-docs-nav" aria-label="Main">
<div class="bd-toc-item active">
<ul class="nav bd-sidenav">
<li class="toctree-l1">
<a class="reference internal" href="../docs/index.html">
Introductory Python
</a>
</li>
</ul>
<p class="caption">
<span class="caption-text">
Materials
</span>
</p>
<ul class="nav bd-sidenav">
<li class="toctree-l1">
<a class="reference internal" href="../materials/00-Introduction.html">
Introduction
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../materials/01-Tools.html">
Tools
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../materials/02-JupyterNotebooks.html">
Jupyter Notebooks
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../materials/03-Variables.html">
Variables
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../materials/04-Operators.html">
Operators
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../materials/05-Conditionals.html">
Conditionals
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../materials/06-DataTypes.html">
DataTypes
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../materials/07-Loops.html">
Loops
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../materials/08-Encodings.html">
Encodings
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../materials/09-FunctionsI.html">
FunctionsI
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../materials/10-Algorithms.html">
Algorithms
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../materials/11-FunctionsII.html">
FunctionsII
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../materials/12-Debugging.html">
Debugging
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../materials/13-Objects.html">
Objects
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../materials/14-Classes.html">
Classes
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../materials/15-Namespaces.html">
Namespaces
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../materials/16-CommandLine.html">
CommandLine
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../materials/17-APIs.html">
The Plan
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../materials/18-OpenSource.html">
OpenSource
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../materials/19-ScientificComputing.html">
Scientific Computing
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../materials/20-Documentation.html">
Documentation
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../materials/21-CodeStyle.html">
Code Style
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../materials/22-CodeTesting.html">
Code Testing
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../materials/23-CodeProjects.html">
CodeProjects
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../materials/24-AdvancedPython.html">
AdvancedPython
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../materials/25-WrapUp.html">
WrapUp
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../materials/A1-Syntax.html">
A1-Syntax
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../materials/A2-Examples.html">
A2-Examples
</a>
</li>
</ul>
<p class="caption">
<span class="caption-text">
Labs
</span>
</p>
<ul class="nav bd-sidenav">
<li class="toctree-l1">
<a class="reference internal" href="../labs/CL1-ProgrammingI.html">
ProgrammingI
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../labs/CL2-ProgrammingII.html">
ProgrammingII
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../labs/CL3-AlgorithmicThinking.html">
AlgorithmicThinking
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../labs/CL4-Exploring.html">
Exploring
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../labs/CL5-CommandLine.html">
CommandLine
</a>
</li>
</ul>
<p class="caption">
<span class="caption-text">
Assignments
</span>
</p>
<ul class="nav bd-sidenav">
<li class="toctree-l1">
<a class="reference internal" href="../assignments/D1-GettingStarted.html">
GettingStarted
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../assignments/D2-Ciphers.html">
Ciphers
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../assignments/D3-Chatbots.html">
Chatbots
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../assignments/D4-ArtificialAgents.html">
ArtificialAgents
</a>
</li>
</ul>
<p class="caption">
<span class="caption-text">
Project
</span>
</p>
<ul class="current nav bd-sidenav">
<li class="toctree-l1 current active">
<a class="current reference internal" href="#">
Overview
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="faq.html">
FAQ
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="ProjectIdeas.html">
Ideas
</a>
</li>
</ul>
</div>
</nav> <!-- To handle the deprecated key -->
<div class="navbar_extra_footer">
Powered by <a href="https://jupyterbook.org">Jupyter Book</a>
</div>
</div>
<main class="col py-md-3 pl-md-4 bd-content overflow-auto" role="main">
<div class="topbar container-xl fixed-top">
<div class="topbar-contents row">
<div class="col-12 col-md-3 bd-topbar-whitespace site-navigation show"></div>
<div class="col pl-md-4 topbar-main">
<button id="navbar-toggler" class="navbar-toggler ml-0" type="button" data-toggle="collapse"
data-toggle="tooltip" data-placement="bottom" data-target=".site-navigation" aria-controls="navbar-menu"
aria-expanded="true" aria-label="Toggle navigation" aria-controls="site-navigation"
title="Toggle navigation" data-toggle="tooltip" data-placement="left">
<i class="fas fa-bars"></i>
<i class="fas fa-arrow-left"></i>
<i class="fas fa-arrow-up"></i>
</button>
<div class="dropdown-buttons-trigger">
<button id="dropdown-buttons-trigger" class="btn btn-secondary topbarbtn" aria-label="Download this page"><i
class="fas fa-download"></i></button>
<div class="dropdown-buttons">
<!-- ipynb file if we had a myst markdown file -->
<!-- Download raw file -->
<a class="dropdown-buttons" href="../_sources/projects/overview.md"><button type="button"
class="btn btn-secondary topbarbtn" title="Download source file" data-toggle="tooltip"
data-placement="left">.md</button></a>
<!-- Download PDF via print -->
<button type="button" id="download-print" class="btn btn-secondary topbarbtn" title="Print to PDF"
onclick="printPdf(this)" data-toggle="tooltip" data-placement="left">.pdf</button>
</div>
</div>
<!-- Source interaction buttons -->
<div class="dropdown-buttons-trigger">
<button id="dropdown-buttons-trigger" class="btn btn-secondary topbarbtn"
aria-label="Connect with source repository"><i class="fab fa-github"></i></button>
<div class="dropdown-buttons sourcebuttons">
<a class="repository-button"
href="https://github.com/introductorypython/"><button type="button" class="btn btn-secondary topbarbtn"
data-toggle="tooltip" data-placement="left" title="Source repository"><i
class="fab fa-github"></i>repository</button></a>
<a class="issues-button"
href="https://github.com/introductorypython//issues/new?title=Issue%20on%20page%20%2Fprojects/overview.html&body=Your%20issue%20content%20here."><button
type="button" class="btn btn-secondary topbarbtn" data-toggle="tooltip" data-placement="left"
title="Open an issue"><i class="fas fa-lightbulb"></i>open issue</button></a>
</div>
</div>
<!-- Full screen (wrap in <a> to have style consistency -->
<a class="full-screen-button"><button type="button" class="btn btn-secondary topbarbtn" data-toggle="tooltip"
data-placement="bottom" onclick="toggleFullScreen()" aria-label="Fullscreen mode"
title="Fullscreen mode"><i
class="fas fa-expand"></i></button></a>
<!-- Launch buttons -->
</div>
<!-- Table of contents -->
<div class="d-none d-md-block col-md-2 bd-toc show noprint">
<div class="tocsection onthispage pt-5 pb-3">
<i class="fas fa-list"></i> Contents
</div>
<nav id="bd-toc-nav" aria-label="Page">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#objectives">
Objectives
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#getting-started">
Getting Started
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#project-topics">
Project Topics
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#project-scope">
Project Scope
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#project-approach">
Project Approach
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#project-requirements">
Project Requirements
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#organizing-your-project">
Organizing Your Project
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#how-to-create-a-zip-file">
<em>
How to create a zip file
</em>
</a>
</li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#rubric">
Rubric
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#external-code">
External Code
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#course-code">
Course Code
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#third-party-code">
Third Party Code
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#provide-attribution">
Provide Attribution
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#modified-code">
Modified Code
</a>
</li>
</ul>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div id="main-content" class="row">
<div class="col-12 col-md-9 pl-md-3 pr-md-0">
<!-- Table of contents that is only displayed when printing the page -->
<div id="jb-print-docs-body" class="onlyprint">
<h1>Guide</h1>
<!-- Table of contents -->
<div id="print-main-content">
<div id="jb-print-toc">
<div>
<h2> Contents </h2>
</div>
<nav aria-label="Page">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#objectives">
Objectives
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#getting-started">
Getting Started
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#project-topics">
Project Topics
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#project-scope">
Project Scope
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#project-approach">
Project Approach
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#project-requirements">
Project Requirements
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#organizing-your-project">
Organizing Your Project
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#how-to-create-a-zip-file">
<em>
How to create a zip file
</em>
</a>
</li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#rubric">
Rubric
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#external-code">
External Code
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#course-code">
Course Code
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#third-party-code">
Third Party Code
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#provide-attribution">
Provide Attribution
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#modified-code">
Modified Code
</a>
</li>
</ul>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div>
<div class="tex2jax_ignore mathjax_ignore section" id="guide">
<h1>Guide<a class="headerlink" href="#guide" title="Permalink to this headline">¶</a></h1>
<p>This is an edited version of the project guidelines for pursuing an independent coding project.</p>
<div class="section" id="objectives">
<h2>Objectives<a class="headerlink" href="#objectives" title="Permalink to this headline">¶</a></h2>
<p>The broad objectives of this project are for you to:</p>
<ul class="simple">
<li><p>Choose a topic that you are interested and work on code related to that idea</p></li>
<li><p>Be able to plan out what is required for a computational solution to your chosen topic</p></li>
<li><p>Design and write an implementation of your project plan in Python code</p></li>
<li><p>Practice following best practices for coding style, documentation and code testing</p></li>
<li><p>Work with different coding tools, including using Jupyter notebooks and Python files</p></li>
</ul>
</div>
<div class="section" id="getting-started">
<h2>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h2>
<p>Suggestions for working on projects:</p>
<ul class="simple">
<li><p>Work consistently</p>
<ul>
<li><p>Slow and steady is a much friendlier way to develop code than a last minute sprint
If you get stuck, pause, and ask for help</p></li>
<li><p>Seek advice when you are unsure, and seek it early and often</p></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="project-topics">
<h2>Project Topics<a class="headerlink" href="#project-topics" title="Permalink to this headline">¶</a></h2>
<p>For your project, you can choose a topic that extends an application from one of the assignments, or propose your own topic.</p>
<p>Possible topics:</p>
<ul class="simple">
<li><p>Encryption (A2)</p></li>
<li><p>Chatbots (A3)</p></li>
<li><p>Artificial Agents (A4)</p></li>
<li><p>Data Analysis (A5)</p></li>
<li><p>Choose your own adventure (propose and develop your own project idea)</p></li>
</ul>
<p>There are more detailed project ideas in the <code class="docutils literal notranslate"><span class="pre">ProjectIdeas</span></code> section.</p>
</div>
<div class="section" id="project-scope">
<h2>Project Scope<a class="headerlink" href="#project-scope" title="Permalink to this headline">¶</a></h2>
<p>The main goal of the project is to demonstrate that you can design and implement code to fulfill some task that you choose. That is, the goal of the project is to plan and write some code that solves a novel problem, one for which the solution is not pre-specified (as compared to and different from the assignments).</p>
<p>There is not a specific amount of code that you have to write for the project. In terms of project scope, your project must implement some new thing, that you design and write the code for. To do so, you are expected to write new code that creates or adds some functionality, and that does so using good code practices. As a rule of thumb, note a project that appropriately responds to this call will have at least a set of new functions, will use code constructs such as loops and conditionals, will import code from available modules when needed, and will do all of this organized into a well constructed organization, in which the code follows proper coding style, is documented, and includes at least one code test.</p>
<p>As the focus of the project is working with Python code, there is <strong>no</strong> prioritization for trying to perform complex tasks. On the contrary, in the face of a complex task in which the work ends up being trying to understand the complex topic you are working on, instead of focusing on working directly with Python code, a simpler project topic is preferred.</p>
</div>
<div class="section" id="project-approach">
<h2>Project Approach<a class="headerlink" href="#project-approach" title="Permalink to this headline">¶</a></h2>
<p>As you work through your project, we recommend taking an approach in which you use a modular design and <strong>prioritize creating a minimal viable product</strong>, using a rapid prototyping approach. These terms will be more fully described in class - but to a first approximation this approach suggests that you organize your design as separate components (modular design), that are independent of each other. Focus first on the core component of the project (minimal viable product) - what piece of it is required such that you have a working implementation of the basic idea that you are targeting. As you work through this, try things out quickly (rapid prototyping) - write some code, check if it works, figure out why or why not, and iterate onto a next version. Once you get the core of the project working, you can add any extra pieces that would be nice and useful to extend the scope of the project, knowing that you have the core idea working.</p>
</div>
<div class="section" id="project-requirements">
<h2>Project Requirements<a class="headerlink" href="#project-requirements" title="Permalink to this headline">¶</a></h2>
<p>To complete the project you must submit your project, which will include Python code (>=3.6) that implements your project. Your <strong>project must include (at least) one Jupyter notebook, one python file (a module file), and one test file.</strong> The Jupyter notebook file will minimally include a description of the project and code that demonstrates your project, organized in cells.</p>
<p>The actual code for the project can be organized into either the notebook, and/or into python files, as either module files and/or scripts. Exactly where and how you organize the code can and should be decided by the project topic itself. For example, projects that are more focused on functions and classes may be more organized into a module organization. For some projects, the code may be well organized into a script that executes your project. For other projects, with more interactive components, much of the code may be presented within the Jupyter notebook. Regardless of the project, the design should be modular and include original code.</p>
<p>Projects are individual, and each person needs to submit a project including (at least some) unique and original code. Projects can also include code that comes directly from the assignments, and/or from working with other students on project ideas, but this should be clearly marked and attributed in your submissions. More details on external code are included below.</p>
</div>
<div class="section" id="organizing-your-project">
<h2>Organizing Your Project<a class="headerlink" href="#organizing-your-project" title="Permalink to this headline">¶</a></h2>
<p>Your project folder should be structured in some organized manner. We provide the following as a suggestion, but you can use a different file structure if necessary:</p>
<p>MyProjectFolder/</p>
<ul class="simple">
<li><p>ProjectNotebook.ipynb</p></li>
<li><p>my_module/</p>
<ul>
<li><p><a class="reference external" href="http://classes.py">classes.py</a></p></li>
<li><p><a class="reference external" href="http://functions.py">functions.py</a></p></li>
<li><p>test_functions.py</p></li>
</ul>
</li>
<li><p>scripts/</p>
<ul>
<li><p>my_script.py</p></li>
</ul>
</li>
<li><p>requirements.txt</p></li>
</ul>
<p>Note that not all of these files / sections are mandatory, and they do not have to use the names specified here - file names can be whatever you want, as long as the organization is clear and what kind of thing each file is is clear. <strong>You must include, at minimum, a Jupyter notebook, and some part of your code should be organized into a module, with a test file</strong>. The scripts section is optional, and should be included if it makes sense to organize your function into an executable script. The requirements text file (optional) should list any modules you use in your project that are not included in the anaconda distribution.</p>
<div class="section" id="how-to-create-a-zip-file">
<h3><em>How to create a zip file</em><a class="headerlink" href="#how-to-create-a-zip-file" title="Permalink to this headline">¶</a></h3>
<p>First, make sure everything is organized into a folder, as you want it. Then:</p>
<ul class="simple">
<li><p>On Mac: right-click on the folder, and click ‘Compress’.</p></li>
<li><p>On Windows: right-click on the folder, go to ‘Send To’ and select ‘Compressed (zipped) folder’.</p></li>
</ul>
<p>In both cases, this will create a zip file, with the name ‘FolderName.zip’.</p>
<p>You can upload this file to Canvas as your project submission.</p>
</div>
</div>
<div class="section" id="rubric">
<h2>Rubric<a class="headerlink" href="#rubric" title="Permalink to this headline">¶</a></h2>
<table class="colwidths-auto table">
<thead>
<tr class="row-odd"><th class="text-align:center head"><p>Component</p></th>
<th class="text-align:center head"><p>Grade Value</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td class="text-align:center"><p>Concept</p></td>
<td class="text-align:center"><p>5%</p></td>
</tr>
<tr class="row-odd"><td class="text-align:center"><p>File Structure</p></td>
<td class="text-align:center"><p>5%</p></td>
</tr>
<tr class="row-even"><td class="text-align:center"><p>Project Description</p></td>
<td class="text-align:center"><p>10%</p></td>
</tr>
<tr class="row-odd"><td class="text-align:center"><p>Approach</p></td>
<td class="text-align:center"><p>20%</p></td>
</tr>
<tr class="row-even"><td class="text-align:center"><p>Project Code</p></td>
<td class="text-align:center"><p>30%</p></td>
</tr>
<tr class="row-odd"><td class="text-align:center"><p>Code Style</p></td>
<td class="text-align:center"><p>10%</p></td>
</tr>
<tr class="row-even"><td class="text-align:center"><p>Code Documentation</p></td>
<td class="text-align:center"><p>10%</p></td>
</tr>
<tr class="row-odd"><td class="text-align:center"><p>Code Tests</p></td>
<td class="text-align:center"><p>10%</p></td>
</tr>
</tbody>
</table>
<p><em>Concept (5%)</em></p>
<p>Your project is directed to fulfill some task that meets the requirements of the project specification. Note that concepts are <em>not</em> graded on complexity. The goal of the project is to choose a task that you can complete in code, and you should choose and work on a task that is interesting to you. As long as your idea is responsive to the project outline, as described above, it will be considered valid.</p>
<p><em>File Structure (5%)</em></p>
<p>Your project includes a clear file organization, and includes at least one Jupyter notebook and one python file (not including the test file), organized into a directory structure.</p>
<p><em>Project Description (10%)</em></p>
<p>Within the Jupyter notebook, there is a description of the project. This description should be written in human language, and provide a self contained description of the project. This can be organized as, for example, a couple paragraphs of text, and/or bullet points, etc.</p>
<p><em>Approach (20%)</em></p>
<p>The approach you designed and implemented to create your project meets these requirements:</p>
<ul class="simple">
<li><p>You use relevant modules (from standard library and external sources)</p></li>
<li><p>The algorithms / approaches used are well chosen for the task at hand</p></li>
<li><p>The algorithms / approaches chosen are properly implemented</p></li>
</ul>
<p><em>Project Code (30%)</em></p>
<p>The code you wrote to implement your design will be graded on the following requirements:</p>
<ul class="simple">
<li><p>Uses appropriate variable types (int, floats, strings, lists, tuples, dictionaries, etc)</p></li>
<li><p>Uses appropriate code constructs (operators, conditionals, loops, error handling, etc)</p></li>
<li><p>Code is organized into functions (necessary) and/or classes (optional)</p>
<ul>
<li><p>You do not necessarily need to use classes (only if they make sense for the project)</p></li>
<li><p>Must include at least 3 original functions or methods</p></li>
</ul>
</li>
<li><p>The code executes, without raising any errors, on expected inputs</p></li>
<li><p>There is a clear modular organization to the code</p></li>
</ul>
<p><em>Code Style (10%)</em></p>
<p>Structurally, we will be evaluating the following criteria:</p>
<ul class="simple">
<li><p>Uses blank lines to separate code elements and logical structure</p></li>
<li><p>Uses good indentation & spacing</p></li>
<li><p>Has 1 statement per line, and line length is not too long (~<80 characters)</p></li>
</ul>
<p>In terms of naming, we will be evaluating the following criteria:</p>
<ul class="simple">
<li><p>Uses descriptive names</p></li>
<li><p>Follows naming conventions</p></li>
<li><p>CapWords for class definitions & snake_case for variables, functions and methods</p></li>
</ul>
<p><em>Code Documentation (10%)</em></p>
<p>Documentation will be evaluated in terms of:</p>
<ul class="simple">
<li><p>Includes docstrings (numpy format) for custom classes, functions, and methods</p></li>
<li><p>Includes appropriate comments within the code</p></li>
</ul>
<p><em>Code Tests (10%)</em></p>
<p>You must include <em>at least three</em> code tests in your project that test your original functions/methods. These should be organized into a test file, in a test folder, and use <code class="docutils literal notranslate"><span class="pre">pytest</span></code>. These tests should be a unit test of your custom functions and/or classes in your project, and should test that the code executes and that at least some of the expected outputs of the function are returned, given some specified inputs.</p>
</div>
<div class="section" id="external-code">
<h2>External Code<a class="headerlink" href="#external-code" title="Permalink to this headline">¶</a></h2>
<p>Your project may include external code - that can be code from the course (assignments, materials, and/or coding labs), code from fellow students, that you perhaps worked on together, and/or code from other sources. Note that this code is not considered original code for the project, and will not be graded. Please follow the following guidelines when doing so.</p>
<div class="section" id="course-code">
<h3>Course Code<a class="headerlink" href="#course-code" title="Permalink to this headline">¶</a></h3>
<p>You are welcome and even expected to take code from the course, in particular code from the assignments. This does not need to be cited, but it also will not count as original/unique code you’ve written. Note that superficial code changes (i.e. simply changing variable/function names) doe NOT count as making code unique/original.</p>
</div>
<div class="section" id="third-party-code">
<h3>Third Party Code<a class="headerlink" href="#third-party-code" title="Permalink to this headline">¶</a></h3>
<p>You may include third party code, external from the course, including demo code and available snippets of code you find available.</p>
</div>
<div class="section" id="provide-attribution">
<h3>Provide Attribution<a class="headerlink" href="#provide-attribution" title="Permalink to this headline">¶</a></h3>
<p>Clear attribution of code is important. Including external code, that you did not write, but failing to indicate that is code you did not write and passing it off as your own is (and will be considered) plagiarism. To cite code indicate in the docstring for the module / function / class or code segment that this code is external code, and include the source of the code.</p>
</div>
<div class="section" id="modified-code">
<h3>Modified Code<a class="headerlink" href="#modified-code" title="Permalink to this headline">¶</a></h3>
<p>It may also be the case that you originally start with code from an external source, but through your project you modify that code - perhaps refactoring it, reorganizing the code, and/ or editing and updating the code organization and functionality. If this is the case, also provide attribution and a link to source, but if you significantly update the code organization and/or functionality (refactoring the code, and/or updating functionality more than just updating naming, style and documentation), then you can and should indicate that this adapted code is to be considered part of your graded project code.</p>
</div>
</div>
</div>
<script type="text/x-thebe-config">
{
requestKernel: true,
binderOptions: {
repo: "binder-examples/jupyter-stacks-datascience",
ref: "master",
},
codeMirrorConfig: {
theme: "abcdef",
mode: "python"
},
kernelOptions: {
kernelName: "python3",
path: "./projects"
},
predefinedOutput: true
}
</script>
<script>kernelName = 'python3'</script>
</div>
<!-- Previous / next buttons -->
<div class='prev-next-area'>
<a class='left-prev' id="prev-link" href="../assignments/D4-ArtificialAgents.html" title="previous page">
<i class="fas fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">Assignment 4: Artificial Agents</p>
</div>
</a>
<a class='right-next' id="next-link" href="faq.html" title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">FAQ</p>
</div>
<i class="fas fa-angle-right"></i>
</a>
</div>
</div>
</div>
<footer class="footer">
<p>
By Thomas Donoghue & Shannon Ellis<br/>
© Copyright 2020-.<br/>
</p>
</footer>
</main>
</div>
</div>
<script src="../_static/js/index.be7d3bbb2ef33a8344ce.js"></script>
</body>
</html>