Python Journal
ASSIGNMENT: For this project, you will learn how to effectively plan, design, develop, and test an original program of your choosing. This program is your choice and it can be as complex as you wish. The goal is to start with an idea for your program and then step through the process of most phases of the development lifecycle to turn your idea into an actual program. This includes planning out the algorithm using pseudocode, coding your program using everything you learned from Units 1-3, and finally testing and debugging your program to make sure it fulfills your intended purpose. Being able to create your own program can be beneficial in any career field. Anything that can be programmed or automated in any industry could make your work a lot easier. Even as a hobby, it can give you a reference point to have a better understanding of how to deal with common issues. Using basic Python to automate menial tasks can save you time and money! Whether you were in this class to learn programming at a professional level or if it’s just for fun, you will benefit from learning coding as a foundation of your technical skills.
For this Touchstone, you will fill out a journal (template link below) which has five sections that correspond to the five steps you will complete for your final project. Use this template to write your journal responses for each section of the project. When you have finished, you will submit this journal as a Word .doc/docx.
The following Example Python Journal Submission will be helpful to you as you work on this assignment and shows acceptable submissions for each entry.
In order to foster learning and growth, all work you submit must be newly written specifically for this course. Any recycled work will be sent back with a 0, and you will be given one attempt to redo the Touchstone.
A. Directions
Step 1: Download and review the Python Journal Template.
Step 2: Review section C (Requirements) to get acquainted with the requirements for this Touchstone before you begin writing your journal entries.
Step 3: Follow the directions for each part of the journal template. Make sure to include in your response all the elements listed under the Requirements section. Prompts in the Inspiration section are not required; however, they may help you to fully think through your response.
Follow the journal creation process that is presented in your Unit 4 lessons to ensure you write a thorough journal entry. There is also an example of a successful journal entry for each submission in Example Python Journal SubmissionEditSign.
Review section B (Rubric) to make sure you have an understanding of how each journal entry will be graded.
Step 4: Once your journal is complete, including the code link, submit your journal for grading.
C. Requirements
The following requirements must be met for your submission:
Use a readable 11- or 12-point font.
All writing must be appropriate for an academic context. Follow academic writing conventions (correct grammar, spelling, punctuation, and formatting).
Journal entries must be original and written for this assignment; plagiarism of any kind is strictly prohibited.
Submission must include your name and the date (included in the template).
Include all of the journal parts in a single file. Acceptable file formats include .doc and .docx.
Include your Share link at the appropriate location in the journal template.
Python Journal Template
Directions: Follow the directions for each part of the journal template. Include in your response all the elements listed under the Requirements section. Prompts in the Inspiration section are not required; however, they may help you to fully think through your response.
Remember to review the Touchstone page for entry requirements, examples, and grading specifics.
Name:
Date:
Complete the following template. Fill out all entries using complete sentences.
PART 1: Defining Your Problem
Task
State the problem you are planning to solve.
Requirements
* Describe the problem you are trying to solve for.
* Describe any input data you expect to use.
* Describe what the program will do to solve the problem.
* Describe any outputs or results the program will provide.
Inspiration
When writing your entry below ask yourself the following questions:
* Why do you want to solve this particular problem?
* What source(s) of data do you believe you will need? Will the user need to supply that data, or will you get it from an external file or another source?
* Will you need to interact with the user throughout the program? Will users continually need to enter data in and see something to continue?
* What are your expected results or what will be the end product? What will you need to tell a user of your program when it is complete?
Problem Statement: Finding Optimal Running Trails
Description: I aim to create a program that assists users in finding optimal running trails based on their preferences such as location, preferred run distance, and trail features. The program will leverage data from OpenStreetMap (OSM) and OpenCage Geocoding APIs to identify running trails within specified geographic areas.
Input Data:
1 City: The user will input the city where they want to find running trails.
2 State: The user will specify the state corresponding to the chosen city.
3 Preferred Run Distance: Users will provide the desired running distance in miles.
Program Functionality:
1 User Interaction:
1 The program will prompt the user to input the city, state, and their preferred run distance.
2 Geocoding:
2 Utilizing the OpenCage API, the program will obtain the bounding box coordinates for the specified city and state.
3 OSM Query:
3 The program will use the obtained coordinates to query the OSM API for running trails within the defined geographic area.
4 Filtering and Ranking:
4 Running trails will be filtered based on the user's preferred run distance.
5 The trails will be ranked by popularity, considering factors such as user ratings or frequency of use.
5 Output Recommendations:
6 The program will present the top-ranked running trails that match the user's preferences.
7 Trail details, including name, distance, elevation information, and a map link, will be displayed.
Expected Results:
* The end product will be a set of recommended running trails that align with the user's specified criteria. The user will receive clear information about the trails, enabling them to make an informed decision about where to go for a run.
Motivation:
* Regular exercise, particularly running, is a popular fitness activity. However, finding suitable running trails can be challenging, especially when exploring new areas. This program aims to simplify the process by providing users with tailored recommendations based on their preferences.
PART 2: Working Through Specific Examples
Task
Write down clear and specific steps to solve a simple version of your problem you identified in Part 1.
Requirements
Complete the three steps below for at least two distinct examples/scenarios.
* State any necessary input data for your simplified problem.
* Write clear and specific steps in English (not Python) detailing what the program will do to solve the problem.
* Describe the specific result of your example/scenario.
Inspiration
When writing your entry below ask yourself the following questions:
* Are there any steps that you don’t fully understand? These are places to spend more time working out the details. Consider adding additional smaller steps in these spots.
* Remember that a computer program is very literal. Are there any steps that are unclear? Try giving the steps of your example/scenario to a friend or family member to read through and ask you questions about parts they don’t understand. Rewrite these parts as clearly as you can.
* Are there interesting edge cases for your program? Try to start one of your examples/scenarios with input that matches this edge case. How does it change how your program might work?
Example/Scenario 1: User Searches for Running Trails in New York City
Input Data:
* City: New York