Assignment 4 - Meteoric Design, Implementation, and Test

Code resources

Submitting code or other solutions from anywhere other than your own brains is cheating.

• Can you research how to use a particular function or library such as pytest? Yes.
• Can you get code that solves all or part of your homework? No.
• When in doubt, ask. I will not be upset if you ask.

Refer to the full details in the Syllabus on Canvas.

Setup

You will complete a program to analyze the NASA Meteorite Landings dataset: https://data.nasa.gov/widgets/gh4g-9sfh. Setup

1. Download assignment4.zip and unzip it. It contains three files:
   • meteorite_landings.csv
   • meteoric.py
   • test_meteoric.py
2. Place these files in an assignment4/ directory if not done for you.
3. Open the assignment4 directory as a PyCharm project.
4. Configure pytest:
   • Mac and Ubuntu on VirtualBox users: Open that directory using PyCharm as usual.
   • Windows users: You can use either native Windows or WSL.
     • If using WSL, follow the setup process at the bottom of this page.
     • If you prefer to use native Windows, run the command pip install pytest pytest-cov from the PyCharm Terminal. Let me know if you get errors and I will help.

Implementation

1. Implement a solution in meteoric.py to the Problem Statement below.
2. Put your name at the top of meteoric.py in the module docstring.
3. You may create classes and files and use imported libraries, but these things are not necessary.
4. Your solution must adhere to the 6 rules of low-level program design. Ask if you have any questions!
5. You are free to modify the provided code, including load_data() code.
6. You will need to implement the haversine formula. You may use code from the web, but include the link to the source website in a code comment.
7. Add docstrings following our conventions to any functions, classes, and files you create.
8. The code must adhere to the PEP8 coding conventions discussed in class.

Testing

1. Add test cases to test_meteoric.py. Any additional source files you create must also have a test_*.py test.
2. All test cases must run from the CLI with pytest.
3. Use pytest --cov --cov-branch --cov-report=html to generate a branch coverage HTML report in your project directory.
4. You must achieve 90% branch coverage in all source files except for the main() function.

Rubric

• (5pts) PEP8 coding conventions followed
• (5pts) Docstring conventions followed for modules (files), classes (if any), and functions.
• (25pts) User commands are correctly implemented, including exception handling of user input errors.
• (10pts) Adherence to our 6 low level design rules.
• (15pts) Multiple test cases with proper test structure for your source code. pytest branch coverage HTML report demonstrating ≥90% branch coverage of all source code except for main().

Problem Statement

Problem outline

Write a program the analyzes the NASA Meteorite Landings dataset available at https://data.nasa.gov/widgets/gh4g-9sfh. The program runs from the Terminal/CLI. The program will have two primary capabilities. The first is to display all meteorites discovered in a given year. The second is to display the meteorite geographically closest to a provided latitude and longitude.

The program must run from the CLI as python meteoric.py <command> <argument>. See the input format and sample inputs for examples of running the program.

Input format

The program must understand the following commands:

• year <integer>: Print out the meteorite name, latitude, and longitude for all meteorites discovered in the <integer> year. It is possible that no meteorites were discovered in a given year. Example usage: python meteoric.py year 1999
• geopoint <latitude,longitude>: Print out the meteorite name, latitude, and longitude for the meteorite with the closest great-circle distance to the coordinates. Latitude is a float in the range [-90.0, 90.0]. Longitude is a float in the range [-180.0, 180.0]. Example usage: python meteoric.py geopoint 34.2257,-77.9447

The data in meteorite_landings.csv looks like this:

name,id,year,reclat,reclong
Aachen,1,1880,50.775,6.08333
Aarhus,2,1951,56.18333,10.23333
Abee,6,1952,54.21667,-113
Acapulco,10,1976,16.88333,-99.9
...

Important: a load_data() function is provided in meteoric.py that loads the data from meteorite_landings.csv into a list of lists. You do not need to validate the data in the CSV file, however, some fields may be blank if the information is missing.

Output format

• Print meteorite data to the console in a human-friendly format.
• When searching for all meteorites that were discovered in a given year the program will either: (a) display a list of meteorites discovered, or (b) display a message stating no meteorites were found for the given year.
• When searching for the closest meteorite landing from a specific location, the program will display the name (or names if two or more meteorites have an equal distance from the specified location) of the meteorite closest to the location given by the user.
• If the user fails to provide a valid command or valid arguments, the console displays an error message indicating what the user did incorrectly.

Exceptional conditions

Do not assume the <command> or <argument> are present or valid. The program must print an error message, not an exception or stack trace, if given bad arguments.

• user can put in an invalid command keyword
• user does not give an argument
• user gives an invalid data type with the year keyword
• user enters a year with no meteorite
• user inputs latitude and longitude incorrectly
• user enters multiple arguments
• user gives an out of range latitude or longitude

Sample input

1. python meteoric.py test: invalid command
2. python meteoric.py year: missing argument
3. python meteoric.py geopoint: missing argument
4. python meteoric.py year s: invalid argument
5. python meteoric.py geopoint abcdef: invalid argument
6. python meteoric.py year 1999 2001 asd: invalid arguments
7. python meteoric.py geopoint 120.884,300.475: invalid latitude and longitude
8. python meteoric.py geopoint 32.558,78.854: valid search by geopoint
9. python meteoric.py year 1818: valid search by year
10. python meteoric.py year 55: valid search by year, no meteorites match that year

Sample output

You may change these to be more precised if you like, but not less precise.

1. Invalid command and argument. Correct format is python meteoric.py <command> <argument>.

2. Invalid command and argument. Correct format is python meteoric.py <command> <argument>.

3. Invalid command and argument. Correct format is python meteoric.py <command> <argument>.

4. Invalid argument. year argument must be an integer.

5. Invalid argument. geopoint argument must be latitude,longitude.

6. Invalid command and argument. Correct format is python meteoric.py <command> <argument>.

7. Invalid argument. geopoint latitude or longitude out of range.

8. Meteorite(s) discovered closest to 32.4, 103.92:
       Guangyuan, latitude: 32.4, longitude: 105.9
   

9. Meteorite(s) discovered in 1818: 
       Seres, latitude: 41.05, longitude: 23.56667
       Slobodka, latitude: 55, longitude: 35
       Zaborzika, latitude: 50.28333, longitude: 27.68333
       Cambria, latitude: 43.2, longitude: -78.8
       Cape York, latitude: 76.13333, longitude: -64.93333
   

10. No meteorites found for the year 55.

Submission due Sunday, March 30

Upload all .py files from your project directory to Assignment 4 on Canvas.

Setup for WSL Users

1. Open PyCharm and select the File menu, then Close Project.
2. Select WSL on the left, then the + button to create a new project.
3. Select the ... button to pick the Project directory.
4. Pick your Ubuntu instance at the top, then navigate to home/<your_id>/seng-201/ and create a new folder (icon at the top) for assignment4.
5. Select the new directory and hit OK.
6. Click Start IDE and Connect on the screen. PyCharm will take a minute to finish configuring. It should open a new window with a main.py file showing some boilerplate code.
7. Select the File menu, then Settings.
8. Select Project: assignment4 in the left pane, then click the Python Interpreter link.
9. Select the Add Interpreter link near the top right, then Add Local Interpreter.
10. Leave the default options selected and hit OK. If you see a red error message, contact the instructor.
11. OK out of the settings screen.
12. Finally, open a new Terminal within PyCharm. Type which pip. You should see something like
    • /home/<your_id>/seng-201/assignment4/.venv/bin/pip, or;
    • /home/<your_id>/virtualenvs/assignment4/bin/pip
    • but not /usr/bin/python
13. You will run all subsequent Terminal commands from the integrated Terminal in PyCharm.
14. run the following in the integrated Terminal:

    pip install pytest pytest-cov
    

15. Complete the setup instructions at the top of this lab.