Problem Set 1 - Due Tue, Sep 12 at 23:59

Reading

  1. The CS111 Problem Set Guide gives an overview of psets, including a detailed description of individual and partner tasks
  2. Lecture 01 slides and notebook
  3. Lab 01
  4. Goldwasser & Letscher, Chapter 3, sections 3.1-3.2, pages 89-103
  5. Our CS 111 Code Style Guide describes rules for Python coding style that you should follow.

About this Problem Set

This problem set will give you practice with basic Python interactive programs as well as creating graphic scenes with the cs1graphics library.

  1. In Task 0, you will familiarize yourself with the course google group, cs111-fall17.
  2. In Task 1, you will write a time profiler program that calculates and visualizes the time spent by a person per week on various activities.
  3. In Task 2 (Partner task), you will create a graphics scene using the cs1graphics package.
  4. Use this shared Google Doc to find and record your pair programming partner. Please DO NOT use the cs111-fall17 group to find partners. Remember, you can talk with other individuals and teams about high-level problem-solving strategies, but you cannot share any code with them.
  5. Read the PS01 FAQ -- it covers the most common issues students encounter when working on PS01.
  6. The CS111 Problem Set Guide gives an overview of psets, including a detailed description of individual and partner tasks.
  7. In previous semesters, cs111 students spent an average of 3.54 hours on Task 1 (min = 1 hour, max = 9 hours) and 3.48 hours on Task 2 (min = 1 hour, max = 9 hours).

All code for this assignment is available in the ps01 folder in the cs111/download directory within your cs server account, which you learned how to access in Lab 1.

Guidelines for checking the correctness and quality of your solution are here.


Task 0: Ask or answer a question on cs111-fall17

On a typical problem set, we expect that you will have many questions.

You can seek answers to these questions from instructors during office hours; from tutors during drop-in hours; from SI leaders during their sessions; and from fellow classmates.

Another important way to ask questions is to post them on the cs111-fall17 Google group. This forum is monitored by the CS111 staff and your classmates, one of whom will try to answer your question in a timely fashion. To get you in the habit of posting to and reading this group, we require that every student posts at least one question or one answer on the cs111-fall17 group in the first couple weeks of the semester.

When do I post my question or my answer?

Tips on posting to the course google group (cs111-fall17)

Tips on email inbox management

With more than 90 students in the cs111-fall17 group, your inbox will quickly fill with messages.

If you have difficulties talk to an instructor or tutor.


Task 1: Time Profiler

This is an individual problem which you must complete on your own, and may ask for help from the CS111 staff.

Armed with Python knowledge from your first CS111 lectures and lab, you've decided to form a software startup that provides your fellow students with useful programs.

Since time is important to all Wellesley students, you've decided your first program should be a time profiler that helps students visualize how they spend their time during a typical week. The program will ask the user to enter a few pieces of information, and then will display a textual representation of the hours they spend in four activities during the week:

  1. Classwork: This includes time in class plus homework time. You may assume in general that two hours of homework time are required for every hour in class.
  2. Activities Outside of Class: This includes time spent in organized athletics, music activities, and clubs, as well as any jobs. Your program will ask the user to name this category.
  3. Sleep: This is the amount of time you spend sleeping each week.
  4. Free Time: For simplicity, this category encompasses all activities not covered by the other three activities above.

Each time you run your program (by pressing the green triangle in Canopy) it should prompt the user to enter information about these activities and display a time profile. Below are three example executions of the time profiling program that show how your program should behave. In each run, text in black is displayed by the program, while text highlighed in magenta is entered by the user. (In your actual program, the text entered by the user will also be displayed in black; we use magenta here only to clarify the distinction between text entered by the user and text displayed by the program.)

Sample Execution #1

What is your name? Valentina

How many classes are you taking this semester? 5

What is the average time in class per week this semester? 2.5

What shall we call the 'everything outside of class' category? fun

How many hours per week do you spend on 'fun'? 15

How many hours per day do you sleep on average? 8

Weekly time profile for Valentina:
37.5 class hours: CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
  15.0 fun hours: XXXXXXXXXXXXXXX
56.0 sleep hours: SSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSS
 59.5 free hours: FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF

Sample Execution #2

What is your name? Emma

How many classes are you taking this semester? 4

What is the average time in class per week this semester? 3.67

What shall we call the 'everything outside of class' category? extracurricular

How many hours per week do you spend on 'extracurricular'? 22.5

How many hours per day do you sleep on average? 6.75

Weekly time profile for Emma:
         44.04 class hours: CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
22.5 extracurricular hours: XXXXXXXXXXXXXXXXXXXXXXX
         47.25 sleep hours: SSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSS
          54.21 free hours: FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF

Sample Execution #3

What is your name? Sofia

How many classes are you taking this semester? 4

What is the average time in class per week this semester? 3.2

What shall we call the 'everything outside of class' category? chill

How many hours per week do you spend on 'chill'? 24

How many hours per day do you sleep on average? 6.55

Weekly time profile for Sofia:
 38.4 class hours: CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
 24.0 chill hours: XXXXXXXXXXXXXXXXXXXXXXXX
45.85 sleep hours: SSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSS
 59.75 free hours: FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
In an earlier version of this pset description, the question that begins How many hours per week do you spend on 'fun' (and similarly for 'extracurricular' and 'chill') had the word activities before the terminal question mark. This was inconsistent with the testing performed by Otter Inspector, so we have remove the word activities from the examples above..

Note that each row of the profile has a number of characters that is the rounded version of the number of hours displayed on the row. So in Sofia's profile, there are 38 Cs, 24 Xs, 46 Ss and 60 Fs. . You should use Xs to indicate the number of 'outside of class' hours. Also note that each number of hours has at least one digit after a decimal point, and at most two.

Note also that your program should ask the user for the name of the category used to describe 'activities outside of class' and then use that name in the remainder of the program. In the first example above, Valentina chose to use the name 'fun', Emma chose to use the label 'extracurricular', and Sofia chose to use the name 'chill'. The user of the program gets to decide which name to use to describe that category, and your program incorporates that name into the profile.

Finally, note that the rows the profile are aligned at the colons that separate the title of each row from the repeated characters. The colons should be aligned correctly regardless of what name is chosen for the 'activities outside of class' category.

In your account on the cs server is the CS111 download folder cs111/download. This folder contains a subfolder name ps01. Begin by copying this ps01 folder to your computer.

In this task, you will write a time profiling Python program timeProfiler.py from scratch in Canopy that has the behavior indicated by the sample executions above. You should save this file to the ps01 folder.

Your goal is to create a timeProfiler.py program that behaves exactly as indicated by the sample executions above, and works reasonably on other sample inputs.

Incremental Development

Any major programming task like this should be broken down into smaller subtasks.

For example, start by writing code to solve the subtask of prompting the user for their name and displaying the header "Weekly time profile for (name):"

Sample Execution for Subtask 1

What is your name? Sofia

Weekly time profile for Sofia:

Second, add a prompt for the number of sleep hours and add a corresponding line to the output display.

Sample Execution for Subtask 2

What is your name? Sofia

How many hours per day do you sleep on average? 6.55

Weekly time profile for Sofia:
45.85 sleep hours

Third, add a prompt for the name of the 'outside of class activities' category.

Sample Execution for Subtask 3

What is your name? Sofia

What shall we call the 'everything outside of class' category? chill

How many hours per day do you sleep on average? 6.55

Weekly time profile for Sofia:
45.85 sleep hours

Fourth, add a prompt for the number of -- in this particular case, chill -- hours, and add a corresponding line to the output display.

Sample Execution for Subtask 3

What is your name? Sofia

What shall we call the 'everything outside of class' category? chill

How many hours per week do you spend on 'chill'? 24

How many hours per day do you sleep on average? 6.55

Weekly time profile for Sofia:
24.0 chill hours
45.85 sleep hours

Continue in this way until you have prompts for all inputs and are able to produce the following (of course, your output will vary depending on what the user enters for the 'outside of class' category). Your program should be able to reproduce the sample executions above for Valentina, Emma and Sofia.

Sample Execution for Subtask 5

What is your name? Sofia

How many classes are you taking this semester? 4

What is the average time in class per week this semester? 3.2

What shall we call the 'everything outside of class' category? chill

How many hours per week do you spend on 'chill'? 24

How many hours per day do you sleep on average? 6.55

Weekly time profile for Sofia:
38.4 class hours
24.0 chill hours
45.85 sleep hours
59.75 free hours

Your remaining subtasks can now add in the repeated characters to create the plot and align everything correctly.

Note that this breakdown into subtasks is just one suggestion. You can break them down any way you prefer. However, trying to write the code for the entire program without breaking it down is a bad idea.

Notes

Later in the semester, we will learn how to check that the inputs are sensible and then require the user to enter valid inputs.

Otter Inspector

When you have a version of timeProfiler.py that you think is close to correct, you can use the Otter Inspector program introduced in Lab01 to test your code. This is a good way to check for any unexpected errors before you submit your code.

To use the Otter Inspector, open the otterInspect.py file in your ps01 folder, and just Run it using the green play button on Canopy. (It contains lots of code that you can safely ignore.) It should bring up a web page indicating whether your timeProfiler.py works as expected. In cases where it does not work correctly, Otter Inspector will show how your output differs from the correct output.

Notice that the page will also tell you that your Honor Code form values are missing. Ignore that aspect for now; you will fill out honocode.py before you submit your ps01 folder.

On some web browsers, Otter Inspector will open a new tab each time you run it. To avoid confusion, close the web page that it opens after you have looked at it.


Task 2: Graphics Scene

This task is a partner problem in which you are required to work with a partner as part of a two-person team.

The ps01 folder contains a copy of the cs1graphics package. We have also included a copy of the cs1graphicsHelper and graphicsState package (used in labs and lectures). In this task, you are to create a new file, scene.py, from scratch in the ps01 folder that creates your own novel scene on a Canvas object. Since we have a limited number of shapes at our disposal, we encourage abstract and creative artwork. Your scene.py file must satisfy the following criteria:

  1. Your file must start with comments at the top, identifying the authors, usernames, problem set number, filename, and date. Follow this format:

    # Wendy Wellesley and Abby Stracksen
    # wwellesl, astracks
    # CS111 Problem Set 1
    # scene.py
    # 09/12/2017
  2. Your file must appropriately import the cs1graphics package (and the cs1graphicsHelper package, if you opt to use it).
  3. Your canvas must have a descriptive title.
  4. You must use at least one instance of each of the following classes: Circle, Ellipse, Rectangle, Polygon, Path, and Text.

  5. You must vary the border thickness and colors of some shapes.
  6. You must vary the interior colors for some of your fillable objects, including at least one that has transparent color.
  7. You must include an Image in your scene. Note that this requires that you include the image file in your ps01 folder when you submit your assignment (GIF files tend to work best). It is OK if your image has a background that is not transparent. Your image will appear in its original form in your graphics scene. Although cs1graphics includes flipping, scaling and rotating, these operations do NOT work with imported images. If you try to flip/scale/rotate your image in cs1graphics, it will turn completely black. To avoid this, you may use Photoshop (or similar image-editing software) to manipulate your image to the desired size/orientation, and then import it into your scene.
  8. You must position at least one object so that it is partially obscuring another object in your scene.

You are welcome to use other cs1graphics features in addition to the ones listed above, but only the above features are required.

After completing this task, you must take a screenshot of your graphics scene, name it correctly, and upload it to the shared google drive folder here. See details below.


How to turn in this Problem Set

In both tasks you will take a screenshot of the output, which you will submit in addition to your code. Here are screenshot instructions.

Soft-copy submission (3 separate steps)

  1. Submit your code (every student)

    • Save your final timeProfiler.py file in the ps01 folder.
    • Each team member should save their scene.py file in their ps01 folder. This file should contain a comment with names of both partners at the top.
    • Also, any image file (GIF files tend to work best) that you use in your graphics scene must be included in the ps01 folder.
    • Fill out the honorcode.py file and save it in the ps01 folder as well. To verify that you've filled it out correctly, run otterInspect.py, and verify that the honorcode part turns green.
    • Note: It is critical that the name of the folder you submit is ps01, and it includes files named timeProfiler.py, scene.py, and honorcode.py. In other words, don't rename the folder that you downloaded, do not delete or rename any files in the 'ps01' folder, and use the exactly the names we have specified for any new files. (Running Canopy and otterInspect.py will automatically create some new files in your ps01 folder; you should not touch or delete these automatically generated files.)
    • Drop your entire ps01 folder in your drop folder on the cs server using Cyberduck by 11:59pm on Tuesday, Sep. 12, 2017.
    • Failure to submit your code before the deadline will result in zero credit for PS01.
  2. Submit your screenshot (one per pair of students)

    Each pair of students in the course must upload a screenshot of their graphics scene to the the shared google drive folder In order to do so, follow these steps:

    • Take a screenshot of your graphics scene (screenshot instructions here).
    • RENAME your screenshot with a short, unique descriptive name that begins with your CS account names. For example, wwellesl_astracks_underwaterMonkey.jpg.
    • Drag your properly named screenshot into the shared google drive folder by 11:59pm on Tuesday, Sep 12, 2017.

Hard-copy submission

There is no hard copy submission. Pset submission is entirely electronic.