diff --git a/installation_instructions/macintosh/LaunchAssociatorJupyterLab.zip b/installation_instructions/macintosh/JupyterLabLaunchAssociator.zip similarity index 92% rename from installation_instructions/macintosh/LaunchAssociatorJupyterLab.zip rename to installation_instructions/macintosh/JupyterLabLaunchAssociator.zip index 21de97432065dbfb0ddc07074c02b10fabae80ea..940722e6c7f576b6e5527bb0c1429298e39ec8b2 100644 Binary files a/installation_instructions/macintosh/LaunchAssociatorJupyterLab.zip and b/installation_instructions/macintosh/JupyterLabLaunchAssociator.zip differ diff --git a/installation_instructions/macintosh/images/.DS_Store b/installation_instructions/macintosh/images/.DS_Store new file mode 100644 index 0000000000000000000000000000000000000000..f7cf7de2d8890e1ab72f9e8237a31751f2d16ebf Binary files /dev/null and b/installation_instructions/macintosh/images/.DS_Store differ diff --git a/installation_instructions/macintosh/images/anaconda_download_button.png b/installation_instructions/macintosh/images/anaconda_download_button.png new file mode 100644 index 0000000000000000000000000000000000000000..2c0af31bad9a6e1450ef38b8917f532388b9eae7 Binary files /dev/null and b/installation_instructions/macintosh/images/anaconda_download_button.png differ diff --git a/installation_instructions/macintosh/images/anaconda_link.png b/installation_instructions/macintosh/images/anaconda_link.png new file mode 100644 index 0000000000000000000000000000000000000000..c0c0983b4ac77b4e6792a2991be5bd9b9b1d4b7f Binary files /dev/null and b/installation_instructions/macintosh/images/anaconda_link.png differ diff --git a/installation_instructions/macintosh/images/download_parent_dir.png b/installation_instructions/macintosh/images/download_parent_dir.png new file mode 100644 index 0000000000000000000000000000000000000000..e55cf3d2672a996b860568c52e5c649589b2cb5c Binary files /dev/null and b/installation_instructions/macintosh/images/download_parent_dir.png differ diff --git a/installation_instructions/macintosh/images/finder.png b/installation_instructions/macintosh/images/finder.png new file mode 100644 index 0000000000000000000000000000000000000000..2d8dfc9924b94ac4c8069ea4b1833f9bd9eaee4d Binary files /dev/null and b/installation_instructions/macintosh/images/finder.png differ diff --git a/installation_instructions/macintosh/images/install_for_all.png b/installation_instructions/macintosh/images/install_for_all.png new file mode 100644 index 0000000000000000000000000000000000000000..25f6054d6647e7b6e32cd39e8ee0fabab8dd3eba Binary files /dev/null and b/installation_instructions/macintosh/images/install_for_all.png differ diff --git a/installation_instructions/macintosh/images/launchpad.png b/installation_instructions/macintosh/images/launchpad.png new file mode 100644 index 0000000000000000000000000000000000000000..8406f400323d9dcceb0ce7d6e4b1a4e22a70a4e3 Binary files /dev/null and b/installation_instructions/macintosh/images/launchpad.png differ diff --git a/installation_instructions/macintosh/images/new_kernel.json.png b/installation_instructions/macintosh/images/new_kernel.json.png new file mode 100644 index 0000000000000000000000000000000000000000..48e7be1aa3b3f2cdb175a08c34e9cb36e13613ad Binary files /dev/null and b/installation_instructions/macintosh/images/new_kernel.json.png differ diff --git a/installation_instructions/macintosh/images/open_with_launcher.png b/installation_instructions/macintosh/images/open_with_launcher.png new file mode 100644 index 0000000000000000000000000000000000000000..4ac89534ddd6ca5095563414632e163384c1956e Binary files /dev/null and b/installation_instructions/macintosh/images/open_with_launcher.png differ diff --git a/installation_instructions/macintosh/images/original_kernel.json.png b/installation_instructions/macintosh/images/original_kernel.json.png new file mode 100644 index 0000000000000000000000000000000000000000..58406d2f3149952d601d0671057fde9bd8aecd69 Binary files /dev/null and b/installation_instructions/macintosh/images/original_kernel.json.png differ diff --git a/installation_instructions/macintosh/images/other_group.png b/installation_instructions/macintosh/images/other_group.png new file mode 100644 index 0000000000000000000000000000000000000000..af10c667c7f4c8db6797ecdc5316517e90e5e6f5 Binary files /dev/null and b/installation_instructions/macintosh/images/other_group.png differ diff --git a/installation_instructions/macintosh/images/other_open.png b/installation_instructions/macintosh/images/other_open.png new file mode 100644 index 0000000000000000000000000000000000000000..948a7b9a30d36f5816d400966e9e0b259a0b2b17 Binary files /dev/null and b/installation_instructions/macintosh/images/other_open.png differ diff --git a/installation_instructions/macintosh/images/proper_python_version.png b/installation_instructions/macintosh/images/proper_python_version.png new file mode 100644 index 0000000000000000000000000000000000000000..de3ae0145072a976095ae9af209942ae5963a97d Binary files /dev/null and b/installation_instructions/macintosh/images/proper_python_version.png differ diff --git a/installation_instructions/macintosh/images/show_filename_extensions.png b/installation_instructions/macintosh/images/show_filename_extensions.png new file mode 100644 index 0000000000000000000000000000000000000000..bc9b2ea5eacdea8ab394d9ee799f0d47f0bed0e8 Binary files /dev/null and b/installation_instructions/macintosh/images/show_filename_extensions.png differ diff --git a/installation_instructions/macintosh/images/show_original.png b/installation_instructions/macintosh/images/show_original.png new file mode 100644 index 0000000000000000000000000000000000000000..458ea04082c1da7e6034994ba75e81dbe939fb12 Binary files /dev/null and b/installation_instructions/macintosh/images/show_original.png differ diff --git a/installation_instructions/macintosh/images/terminal_logo.png b/installation_instructions/macintosh/images/terminal_logo.png new file mode 100644 index 0000000000000000000000000000000000000000..0ab778c800514aac7a5416538b4b14f065569ee2 Binary files /dev/null and b/installation_instructions/macintosh/images/terminal_logo.png differ diff --git a/installation_instructions/macintosh/installation_instructions.md b/installation_instructions/macintosh/installation_instructions.md new file mode 100644 index 0000000000000000000000000000000000000000..fd7fb5a003933c94968a56f77174b03a3f8c0f13 --- /dev/null +++ b/installation_instructions/macintosh/installation_instructions.md @@ -0,0 +1,68 @@ +# Installation Instructions for MacOS + +This document will walk you through the steps you need to perform to install and configure **Jupyter Lab**, the development software you will use for CS220. You need to perform 5 steps: + +1. Download and install Anaconda +2. Change the Python version +3. Enable the debugger +4. Associate notebook files with Jupyter lab +5. Test your configuration + +## 1. Download and install Anaconda + +[Anaconda](https://www.anaconda.com/) is a suite of software programs used for data science. In a browser go to Anaconda's download page [https://www.anaconda.com/download/](https://www.anaconda.com/download/) to download the software. You can either provide an email address and click the submit button or click the **Skip registration** to bypass providing your email. + +On the download page, it should have detected your operating system and provided a link at the top of the page for the proper version. You will need to know if your computer is an Apple Silicon or Intel chip. If you click on the apple logo in the top left corner of your screen and select "About this Mac" a window will show you either the *Chip* type (Apple) or the *Processor* type (Intel) of your computer. + + + +Download and run the installer, following the instructions. On the "Select a Destination:" page select "Install for all users of this computer" and finish running the installer. + + + +## 2. Change Python version + +You will be submitting your code to our grader, which is running a slightly older version of Python, version 3.10.12. So you need to make sure you are running the same version on your computer. Click on the Launchpad logo <img alt="Launchpad logo" src="images/launchpad.png" width="50px"> and find and click on the other group <img alt="other group" src="images/other_group.png" width="50px"> and then on the terminal <img alt="terminal logo" src="images/terminal_logo.png" width="50px"> to open a program where you can type commands. In the terminal window, type the command `conda install python=3.10.12` and press enter. Follow the instructions to have it proceed and install that version of Python. When it is finished you can check that it has installed the proper version by typing `python --version` and then exit terminal. + + + + +## 3. Enable the debugger + +One feature of Jupyter Lab that we will use this semester is the debugger. It is disabled by default. To enable it you will need to edit a text file. Start by opening the finder + <img alt="finder logo" src="images/finder.png" width="50px"> and in the sidebar, click on Applications. Anaconda Navigator will be one of the applications listed. + + + +Now control-click on the Anaconda Navigator logo and select "show original" in the pop-up menu. Browse inside the `anaconda3` folder to the `share\jupyter\kernels\python3\` folder and double click to open the kernel.json file in TextEdit. + + + +The line that reads `"debugger": false` needs to be changed to be `"debugger": true` and then save the file. + + + +## 4. Associate Notebook Files with Jupyter Lab + +The files that we will be working with this semester are called *Jupyter Notebook* files. These files have a file extension of `.ipynb`. You can make it so that when you double click on a file that ends in `.ipynb` it will be opened by Jupyter Lab. Download the [Test Configuration Notebook](https://git.doit.wisc.edu/cdis/cs/courses/cs220/cs220-lecture-material/-/raw/main/installation_instructions/test_configuration.ipynb?ref_type=heads&inline=false) and a [Jupyter Lab Associator Program](https://git.doit.wisc.edu/cdis/cs/courses/cs220/cs220-lecture-material/-/raw/main/installation_instructions/JupyterLabLaunchAssociator.zip?ref_type=heads&inline=false) which we will use to make the file assocation. Open your Downloads folder with finder. Click on the `JupyterLabLaunchAssociator.zip` file and type Command-C to copy the file name. Then control-click on the "Downloads" folder at the top of the window to see the parent directories and select the folder with your username. + + + +In your username directory type option-command-V to move the zip file here and double-click on the zip file to extract the application. + +In finder, go back to the Download's directory and control-click on the notebook file you downloaded. In the pop-up menu select "open with -> other..." option + + + +In the window browse to where you expanded the zip file to extract the application (i.e. click Download then go to the parent directory) and select the JupyterLabLauncher.app icon. Before you click "Open" make sure you checkmark the "Always Open With" checkbox. + + + + + +Go back to the Downloads folder and double-click to try and open the notebook file. + + +## 5. Test the configuration + +Now, whenever you double-click on a Jupyter Notebook file, it should open that file in Jupyter Lab. Follow the steps in the notebook to check your configuration and your software should be installed and configured correctly. \ No newline at end of file