git-intro

A demo repository for assignment submission.

Clone a repo

git clone <URL from the github.com GUI>

Update a repo

Remember, before making local changes:

git pull

• Remember to add/update the .gitignore file to keep big things out of version control.
• Commit your changes and push them back to github:

git add .
git commit -m "some informative message about what I did"
git push origin main

Document for reproducibility

Results must be reproducible. Provide clear instructions for every step, including data access.

• Step 1: Download the CSV file from the ISL website with the following command

make data

• You need to do this when you first clone the repo because CSV files are .gitignored.
• Note: If you keep a local copy of a dataset, be sure to provide appropriate attribution.
• Be very clear about anything you did to process the data.
• This repo uses "make"
  • One nice thing about make is that you can edit the Makefile without having to edit this README.
  • One annoying thing about make is that indents in the Makefile must be tabs -- spaces don't work.
• If you're using Windows, then consider WSL.
  • In that case, make will be installed with the Linux distribution

Reproducible results

Recreate the chart below with

make q1

Here's the first chart in Figure 1.1 of ISLR2, embedded with HTML.

This demonstrates another way to embed a PNG...

Saving an environment

I created the requirements.txt by first running this command

conda list -e > requirements.txt

Then I edited it to include only the modules that I imported in my code, along with the python version.

conda list -e > requirements.txt

You can use the requirements.txt to create a conda environment and run code as follows:

conda create --name demo --file requirements.txt
conda activate demo
make app
conda deactivate

github pages

• github pages
• Activate a github-pages site for a repository in Settings > Pages
• I do NOT recommend using Jekyll for this class.

seaborn issue

I encountered an issue on my older Mac. For some reason (python not installed as a framework?), plt.show() with seaborn hangs my terminal. Fix this by turning off interactive mode:

plt.ioff()

You can also fix this by using a different backend:

matplotlib.use('TkAgg')

List all the backends and the current backend with:

print(plt.get_backend())
print(matplotlib.rcsetup.all_backends)

Or, to avoid using matplotlib, add the following to ~/.zprofile:

# Avoids seaborn hang on my old macbook pro
export MPLBACKEND=qtagg