Skip to content
Snippets Groups Projects
Commit 641a5690 authored by Louis Oliphant's avatar Louis Oliphant
Browse files

first stab and mac instructions

parent 4b4a7411
No related branches found
No related tags found
No related merge requests found
Showing
with 68 additions and 0 deletions
File added
installation_instructions/macintosh/images/anaconda_download_button.png

15.2 KiB

installation_instructions/macintosh/images/anaconda_link.png

133 KiB

installation_instructions/macintosh/images/download_parent_dir.png

112 KiB

installation_instructions/macintosh/images/finder.png

19.3 KiB

installation_instructions/macintosh/images/install_for_all.png

190 KiB

installation_instructions/macintosh/images/launchpad.png

17 KiB

installation_instructions/macintosh/images/new_kernel.json.png

63.8 KiB

installation_instructions/macintosh/images/open_with_launcher.png

424 KiB

installation_instructions/macintosh/images/original_kernel.json.png

62.4 KiB

installation_instructions/macintosh/images/other_group.png

47.5 KiB

installation_instructions/macintosh/images/other_open.png

98.7 KiB

installation_instructions/macintosh/images/proper_python_version.png

116 KiB

installation_instructions/macintosh/images/show_filename_extensions.png

89.4 KiB

installation_instructions/macintosh/images/show_original.png

168 KiB

installation_instructions/macintosh/images/terminal_logo.png

25.8 KiB

# 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 button](images/anaconda_download_button.png)
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.
![Install for all users](images/install_for_all.png)
## 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.
![Command to Check Python Version](images/proper_python_version.png)
## 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.
![Finder's Application Window showing Anaconda](images/anaconda_link.png)
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.
![Original content of kernel.json](images/original_kernel.json.png)
The line that reads `"debugger": false` needs to be changed to be `"debugger": true` and then save the file.
![New content of kernel.json](images/new_kernel.json.png)
## 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.
![Download's parent directory](images/download_parent_dir.png)
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
![other option](images/other_open.png)
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.
![jupyterlab launch associator](images/open_with_launcher.png)
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
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment