update project docs

Author: ShanEllis

ProjectIdeas.ipynb

@@ -107,7 +107,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -121,7 +121,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.5"
+   "version": "3.9.7"
   }
  },
  "nbformat": 4,

PythonParty.ipynb

@@ -10,67 +10,8 @@
    "source": [
     "**Course Announcements**\n",
     "\n",
-    "- **A4** due Mon 2/28 (11:59 PM)\n",
-    "- **CL7** due Wednesday (3/2)\n",
-    "\n",
-    "**Note**\n",
-    "- Prof Ellis' OH: extra **zoom office hours today 9-10 AM** (will use normal zoom link on canvas; make-up for Monday)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {
-    "slideshow": {
-     "slide_type": "fragment"
-    }
-   },
-   "source": [
-    "**Black History Month**: Foundational Fridays\n",
-    "\n",
-    "- [Kimberly Bryant](https://twitter.com/6Gems) - founder and CEO of BlackGirlsCode\n",
-    "- [Dr. Joy Buolamwini](https://twitter.com/jovialjoy) - founder of the Algorithmic Justice League\n",
-    "- [Dr. Timnit Gebru](https://twitter.com/timnitGebru) - founder of The Distributed AI Research Institute; AI Ethics\n",
-    "- [Erica Baker](https://twitter.com/EricaJoy) - CTO at DCCC\n",
-    "\n",
-    "Note: From 1977 to 2013, the. largest # of black women to earn a CS PhD in any given year was...10"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {
-    "slideshow": {
-     "slide_type": "notes"
-    }
-   },
-   "source": [
-    "**Q&A**\n",
-    "\n",
-    "Q: is there an easy way to download all the lecture notes from datahub using code in the terminal on my computer?  \n",
-    "A: Yes - you can zip/tar all the contents on datahub into a single file, download, and then unzip/untar on your computer. I will provide instructions on this at the end of the quarter.\n",
-    "\n",
-    "Q: I was using cat, and it wasn't printing anything out even though I know that new_file was placed within dir_name. Is there a reason for this?  \n",
-    "A: This is likely b/c you didn't add any contents to that file. Open that file up, add some text, and try `cat` again.\n",
-    "\n",
-    "Q: I still don't understand the purpose of using the command line.   \n",
-    "A: Quickly navigate to and organize files. Also, run python scripts (we'll be doing this today).\n",
-    "\n",
-    "Q: Why can't we just stick to jupyter for an intro class  \n",
-    "A: Because understanding how to work with .py files is critical for moving forward/understanding other code you see out in the world.\n",
-    "\n",
-    "Q: What does `!cd ~/` do?  \n",
-    "A: Takes you to your home directory. If you're already in your home directory...it will leave you where you are.\n",
-    "\n",
-    "Q: How do we use the command line directly on our computer, like in our computer's terminal?   \n",
-    "A: Search for \"terminal\" on your computer (if you don't have a terminal application already installed (depends on your computer), you could download a \"bash shell\". (I use iTerm.)\n",
-    "\n",
-    "Q: What is the difference between shell command and command line? Is there a difference?  \n",
-    "A: The command line is where you type shell commands. So, when you open up a terminal and get the black background, that is the command line. One thing you can do at the command line is type shell commands.\n",
-    "\n",
-    "Q: Is the command line somewhere we are able to write code or is it purely used for locating files, documents, and code that has already been written? A follow-up question if we don't write code in the command line would be where would we write code then? Just in another Jupyter Notebook file that we then retrieve using the command line?  \n",
-    "A: In a text editor! (The part of the notes we didn't get to on Wednesday but will discuss today.)\n",
-    "\n",
-    "Q: How is array different from other collections (like tuples, lists, dictionaries)?  \n",
-    "A: We'll discuss arrays next week when we discuss `numpy`, but for now, arrays can be N-dimensional."
+    "- **A4** accepted for full credit until late deadline tonight (11:59 PM)\n",
+    "- **E2** take-home due Friday at 11:59 PM"
    ]
   },
   {
@@ -83,7 +24,7 @@
    "source": [
     "# Python Party!\n",
     "\n",
-    "It's a bit less of a party while learning remotely..."
+    "Parties have snacks - come on up and grab snacks! "
    ]
   },
   {
@@ -148,8 +89,8 @@
    "source": [
     "Caveats if you take the final exam:\n",
     "1. The highest grade you can get in the course is an A (not an A+)\n",
-    "2. There is no additional opportunities for extra credit (Note: if you've been filling out daily participation surveys that EC *will* apply to both exam and project)\n",
-    "3. You have to complete on your own (same rules as previous midterms)"
+    "2. There is no additional opportunities for extra credit (Note: if you've been answering ClassQuestin that EC *will* apply to both exam and project)\n",
+    "3. You have to complete on your own (same rules as previous midterms, but it's completely take-home)"
    ]
   },
   {
@@ -234,7 +175,7 @@
     "2. Brainstorm an idea\n",
     "3. Design what \"pieces\" (functions/classes/etc.) you need to execute that idea\n",
     "4. Start writing code + tests\n",
-    "5. Submit on 1) Canvas or 2) datahub"
+    "5. Submit on 1) datahub or 2) Canvas"
    ]
   },
   {
@@ -312,7 +253,7 @@
     }
    },
    "source": [
-    "#### Clicker Question #1\n",
+    "#### Class Question #1\n",
     "Do you have an idea of what you want to do for your **project**?\n",
     "\n",
     "- A) absolutely no idea\n",
@@ -332,8 +273,9 @@
    "source": [
     "### Example Projects: \n",
     "\n",
-    "* Previous Examples: https://github.com/COGS18/Projects#projects\n",
-    "* Andrew's project video"
+    "* Josh S!\n",
+    "* Mingson: https://www.youtube.com/watch?v=ipEj5DtkopA&feature=youtu.be\n",
+    "* Previous Examples: https://github.com/COGS18/Projects#projects"
    ]
   },
   {

faq.md

@@ -1,44 +1,28 @@
-<!-- #region -->
+---
 # Project FAQ
-
 This document is meant to answer a number of commonly-asked questions about the COGS 18 final project. We hope you find it helpful as you develop your awesome projects!
-
-
 ## File Structure and Requirements 
-
 #### Do we still need a .py file if all our code and functions are in a Jupyter notebook?
-Yes, you need at least one .py file - either a module or a script. It can have both, but that is not required.
-
+Yes, you need at least one .py file - a module that stores your code. If all of your code is in your notebook, it's time to reorganize.
 #### What is the difference between a script and a module?
 A module stores functions/classes that you'll want to use later, perhaps in your script or notebook. Scripts include code intended to run from top to bottom and will likely use the functions in your module.
-
 #### How do I create a script or module?
 On Datahub or Anaconda, in the new tab at the top right, select text file. When you save that file, save it with a .py extension. Alternatively, from the terminal, you can use the `touch` command.
-
 #### What goes in requirements.txt?
 You should mention if you installed any new packages via pip for your project that aren’t included by default in the anaconda distribution/datahub so we'll be able to run your code properly. If you didn't install anything to run your code, you don't need to include this file.
-
 #### How do I install a library?
 Use pip in the terminal. On datahub, the command will look something like: `pip install --user package`.
-
 #### Is there a set number of functions or classes we need to include?
 You need at least 3 original functions or methods. There is no class requirement. (For example, you could have a single class with 3 methods. Or, no classes and 3 separate functions.)
-
 #### Can I write my entire project code into one class?
 Yes, as long as the class includes a modular design where there are multiple independent methods.
-
 #### Are we supposed to call our files and directories functions.py, ProjectNotebook.ipynb, etc. or should we call them something related to the project itself?
 You could change the names if you'd like or keep them as they are. Just make sure to import using the correct file names.
-
 #### Can I submit the project using a different file structure than the template provided?
 Yes, the specific file structure is not important. We care that you have a folder that contains a notebook and a script/module file (or both). Other files can also be included if applicable. Use an oganization structure that makes sense for your project.
-
 #### How/in what format should the files be submitted?
 For submitting your final projects, you will either 1) zip up all the files for your project (i.e. Notebook + module directory with tests and functions) and submit the zipped file on Canvas or 2) submit on datahub.
 
----
-<!-- #endregion -->
-
 ## Importing Modules
 
 #### I wrote a function in a file, and I am trying to use it a separate file; however, it says that my function "is not defined".
@@ -50,7 +34,6 @@ Check the location of the file that contains your functions. If your my_function
 More resources for importing modules:
 https://docs.python.org/3/tutorial/modules.html
 
----
 
 ## Citations
 
@@ -63,7 +46,6 @@ This is fine and good practice. Including a comment (`#`) with the URL is suffic
 #### Is it okay to use the code from Assignment X as long as I make some modifications? Will I be marked down for not coming up with it on my own?
 This is fine as long as you cite your sources with a comment and write at least 3 original functions/methods that are not from the Assignment.
 
----
 
 ## Documentation and Comments
 
@@ -79,7 +61,6 @@ No need to describe the methods; just describe what the class is used for briefl
 More resources for formatting docstrings:
 https://numpydoc.readthedocs.io/en/latest/format.html#documenting-class-instances
 
----
 
 ## Testing
 
@@ -99,7 +80,6 @@ If you open up a terminal and navigate to the directory where your test function
 The simplest way is to move the user input outside of the function and give it as a parameter to the function. Otherwise, we recommend checking out this link: 
 https://stackoverflow.com/questions/35851323/how-to-test-a-function-with-input-call
 
----
 
 ## DataHub Troubleshooting
 
@@ -116,7 +96,6 @@ There are two general approaches (with option 1 being the simpler one):
 
 2. Use the command line on datahub to zip files up (if you're comfortable with how to do this), and download the zipped file to desktop to submit.
 
----
 
 ## Submission 
 
@@ -126,7 +105,6 @@ Canvas or Datahub.
 #### How many times can I submit the project?
 You can submit as many times as you'd like, but the most recent submission is what we'll grade.
 
----
 
 ## Other Questions
 
@@ -139,5 +117,5 @@ No, all you need to do is make sure to turn in your final project.
 #### How do I specify extra credit?
 There is an extra credit opportunity on the final project. If you go above and beyond the requirements of the project and/or teach yourself something new in the process of completing the final project, explain this in the final cell of the Jupyter Notebook you turn in. This should include 1) your background in programming prior to this course and 2) a description of how you went above and beyond and/or what you learned in the process of completing the project.
 
----
 *This document was originally written by [Severine Soltani](https://github.com/SevSoltani), an awesome COGS 18 Instructional Assistant. Thanks to Severine for taking the time to draft this to help students going forward!*
+---

overview.md

@@ -20,7 +20,7 @@ The broad objectives of this project are for you to:
 
 ### Getting Started
 
-We strongly encourage you to discuss potential project ideas and with your TAs/IAs/instructor through office hours and coding labs (or on Campuswire). This will give us a chance to give you feedback and help guide your project plans.
+We strongly encourage you to discuss potential project ideas and with your TAs/IAs/instructor through office hours and coding labs (or on Piazza). This will give us a chance to give you feedback and help guide your project plans.
 
 Suggestions for working on projects:
 
@@ -81,7 +81,7 @@ As you work through your project, we recommend taking an approach in which you u
 
 To complete the project you must submit your project, which will include Python code (>=3.6) that implements your project. Your **project must include (at least) one Jupyter notebook, one python file (a module file), and one test file.** The Jupyter notebook file will minimally include a description of the project and code that demonstrates your project, organized in cells.
 
-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.
+Most of the actual code for the project will be organized 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, all code may be organized into a module. For some projects, the code may be well organized into a script that imports from your module to execute 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.
 
 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.