index.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "0be3205f",
   "metadata": {},
   "source": [
    "# Setting up a Professional Data Science Environment - Configuring Git and Anacond"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "16458211",
   "metadata": {},
   "source": [
    "## Introduction\n",
    "\n",
    "In this lesson, you'll continue setting up your professional data science environment by configuring your terminal to work with GitHub, creating an Anaconda virtual environment, setting up your new virtual environment to open by default from your terminal, and confirming your configuration."
   ]
  },
  {
   "cell_type": "markdown",
   "id": "f1371247",
   "metadata": {},
   "source": [
    "## Objectives\n",
    "\n",
    "You will be able to:\n",
    "\n",
    "* Use basic commands to navigate the command line\n",
    "* Practice utilizing Git and GitHub\n",
    "* Summarize why virtual environments are used\n",
    "* Set up a virtual environment"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "42a1d6f6",
   "metadata": {},
   "source": [
    "## Connecting Your Terminal to GitHub\n",
    "\n",
    "Now that you have Git installed locally, you'll be often working back and forth between GitHub, a service which hosts Git repositories online, and your local computer. You will first need to [sign up for a GitHub account](https://github.com/signup). Next, to better integrate with GitHub, you should set up your name and email address on your local machine:\n",
    "\n",
    "1. In your terminal window\\*, type `git config --global user.name`\n",
    "    - If it returns your name, you’re set!\n",
    "    - If it returns nothing or displays an error message, type `git config --global user.name “Your Name”` - replacing Your Name with your name inside the quotes (this should be your real first and last name, not your GitHub username)\n",
    "\n",
    "2. In your terminal window, type `git config --global user.email`\n",
    "    - If it returns your email address, you’re set!\n",
    "    - If it returns nothing or displays an error message, type `git config --global user.email your@email.com` - replacing your@email.com with your email address\n",
    "\n",
    "\\* Remember, when we say \"terminal\" we mean the Terminal app for Mac, and the Git Bash program for Windows"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "70447ccf",
   "metadata": {},
   "source": [
    "## Cloning this Repository\n",
    "\n",
    "To complete the later steps in this configuration process, you’re going to need to download a copy of the files in this repository, so we should do this now since you already have a terminal window open.\n",
    "\n",
    "You should get in the habit of checking exactly where you are in your Terminal before downloading anything. Use the command `pwd` to print your working directory. If you're not in a place you want to download lessons, you should navigate to a place you want to keep your Flatiron repositories and files.\n",
    "\n",
    "If you have not used the command line much or at all, follow the below steps:\n",
    "\n",
    "1. Open a new terminal window\n",
    "2. Type `pwd` - this should show your home directory, the most basic of paths on your computer\n",
    "3. Type `cd Documents` - this will change your directory, and move you into your Documents folder\n",
    "4. Type `mkdir Flatiron` - this will create a new folder, called Flatiron, to keep all of your Flatiron repositories and files\n",
    "5. Type `cd Flatiron` - this will change your directory, moving you into the new Flatiron folder you just created\n",
    "\n",
    "MacOS Example:\n",
    "\n",
    "<img src=\"https://raw.githubusercontent.com/learn-co-curriculum/dsc-data-science-env-config/master/images/mac-make-flatiron-directory.png\" width=\"450\">\n",
    "\n",
    "Windows Example:\n",
    "\n",
    "<img src=\"https://raw.githubusercontent.com/learn-co-curriculum/dsc-data-science-env-config/master/images/windows_create_dir.png\" width=\"450\">\n",
    "\n",
    "> ## Important Note\n",
    ">\n",
    "> You should **NEVER** clone a Git repository into another Git repository!\n",
    ">\n",
    "> You can always check if you are currently in a Git repository by running `git status`. If you get an error that says \"`fatal: not a git repository (or any of the parent directories): .git`\", then you are not in a Git repository.\n",
    "\n",
    "Once you are in a good place to download files from GitHub, like a general folder to keep all of your Flatiron repositories and files, type (or better still, copy and paste) `git clone https://github.com/learn-co-curriculum/dsc-data-science-env-config.git`\n",
    "\n",
    "_In Windows, in Git Bash, to paste from the clipboard the shortcut should be **shift-insert**_\n",
    "\n",
    "This will create a new subdirectory whose name is \"dsc-data-science-env-config\" which will contain a copy of all of the files in this repository!\n",
    "\n",
    "Move into that directory using the `cd`, or change directory, command (after typing `cd dsc` you should be able to hit the **tab** key to \"tab complete\" so you don't need to type the whole directory name).\n",
    "\n",
    "Now, if you run `pwd` to print your working directory again, you should be inside the folder we just cloned down from that GitHub link!\n",
    "\n",
    "MacOS Example:\n",
    "\n",
    "<img src=\"https://raw.githubusercontent.com/learn-co-curriculum/dsc-data-science-env-config/master/images/mac-git-clone.png\" width=\"650\">\n",
    "\n",
    "Windows Example:\n",
    "\n",
    "<img src=\"https://raw.githubusercontent.com/learn-co-curriculum/dsc-data-science-env-config/master/images/win_git_clone.png\" width=\"650\">"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "0c92c245",
   "metadata": {},
   "source": [
    "## Setting Up Virtual Environments\n",
    "\n",
    "As you do data science projects, you will spend a lot of your time using pre-written libraries to speed up your development - like numpy, pandas, or scikit-learn. As you work on different projects, you may also find that you use different versions of different libraries for different projects. The most common versioning issue is that some projects will run in Python 2 whereas others will run in Python 3, but you may also find that different projects depend on different versions of libraries like Tensorflow.\n",
    "\n",
    "Occasionally, code that works in an old version of a library won’t work in a newer version. So if you open up a new project and install the dependencies, it’s possible that your old project won’t work anymore.\n",
    "\n",
    "To avoid that problem, a best practice is to use “virtual environments”. Virtual environments allow you to have different versions of Python and different versions of the various libraries you use, so you can install a new version of a library for one project but still use the old version for another project. It’s almost as if you have multiple computers that you can swap between, each having a different setup and configuration, just by running a couple of commands.\n",
    "\n",
    "There is a built-in virtual environment feature in Python, but we’re going to use the more flexible virtual environments provided by Conda as part of the Anaconda distribution you installed.\n",
    "\n",
    "To use a new virtual environment, there are two steps you need to complete. The first step is to create the virtual environment. That may take a couple of minutes as your computer has to download the necessary version of Python and all of the libraries that you want to be able to use in that environment. The next step then is to “use” the virtual environment by activating it.\n",
    "\n",
    "If you want to learn more about Conda environments, have a look at the <a href=\"https://conda.io/docs/user-guide/tasks/manage-environments.html\" target=\"_blank\">documentation</a>, otherwise, let’s give this a try."
   ]
  },
  {
   "cell_type": "markdown",
   "id": "d17ee8c7",
   "metadata": {},
   "source": [
    "### Creating the Conda Virtual Environment\n",
    "\n",
    "You need to start by navigating into this project folder. If you run `pwd` to print your working directory in your terminal, you should be inside the folder we cloned down. If the name of the current working directory is not \"dsc-data-science-env-config\", then you need to move into that folder - follow the steps above.\n",
    "\n",
    "The instructions to create the environment are slightly different for MacOS and Windows, because they need to use different environment files, so make sure you follow the instructions relevant to your operating system.\n",
    "\n",
    "**MacOS**: run `conda env create -f mac_environment.yml`\n",
    "\n",
    "**Windows**: run `conda env create -f win_environment.yml`\n",
    "\n",
    "Depending on the speed of your computer and your internet connection it may take up to twenty minutes for this to complete. While it does you should see output similar to that displayed below start to appear in your terminal.\n",
    "\n",
    "MacOS Example:\n",
    "\n",
    "<img src=\"https://raw.githubusercontent.com/learn-co-curriculum/dsc-data-science-env-config/master/images/mac-env-create-from-yml.png\" width=\"450\">\n",
    "\n",
    "Windows Example:\n",
    "\n",
    "<img src=\"https://raw.githubusercontent.com/learn-co-curriculum/dsc-data-science-env-config/master/images/win_env_create.PNG\" width=\"450\">"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "c760e097",
   "metadata": {},
   "source": [
    "### Activating the Conda Virtual Environment\n",
    "\n",
    "Next, run `conda init bash` to initialize a permanent shell which adds shell code to the startup scripts of your shell (e.g. ~/.bashrc). Now you are ready to try activating the environment. Type `conda activate learn-env`.\n",
    "\n",
    "To confirm that it worked, type `conda info --envs` and confirm that the asterisk (*) is next to the learn-env environment.\n",
    "\n",
    "MacOS Example:\n",
    "\n",
    "<img src=\"https://raw.githubusercontent.com/learn-co-curriculum/dsc-data-science-env-config/master/images/mac-conda-info-envs.png\" width=\"450\">\n",
    "\n",
    "Windows Example:\n",
    "\n",
    "<img src=\"https://raw.githubusercontent.com/learn-co-curriculum/dsc-data-science-env-config/master/images/win_env_check.PNG\" width=\"450\">\n",
    "\n",
    "Note: For Windows 11, you may need to follow the steps here in order to run [conda activate learn-env](https://discuss.codecademy.com/t/setting-up-conda-in-git-bash/534473)."
   ]
  },
  {
   "cell_type": "markdown",
   "id": "76583d09",
   "metadata": {},
   "source": [
    "## Troubleshooting\n",
    "\n",
    "if you see a message that states “WARNING: A newer version of Conda exists”, run `conda update -n base conda` and then try again to create the environment.\n",
    "\n",
    "If you see a message that states \"file not found\", double check that you are running this command from the directory that contains the .yml file. If you type `ls` you should see the environment.yml file. If you don't see it, you likely forgot to run `cd dsc-data-science-env-config` to change into the right directory."
   ]
  },
  {
   "cell_type": "markdown",
   "id": "f97b3311",
   "metadata": {},
   "source": [
    "## Setting your Default Environment\n",
    "\n",
    "You have successfully created your virtual environment! But, to be sure that you are using the learn-env, it's helpful to set it as your default environment so that you don't need to remember to manually switch to it every time you open the terminal. This step is **highly recommended** but not required."
   ]
  },
  {
   "cell_type": "markdown",
   "id": "7d44f37b",
   "metadata": {},
   "source": [
    "### Mac\n",
    "\n",
    "On a Mac, we need to first see what shell you're running in your terminal. Run `echo $SHELL`.\n",
    "\n",
    "If the response ends in `bash`:\n",
    "\n",
    "- run `echo \"conda activate learn-env\" >> ~/.bash_profile` to add the configuration to your bash profile\n",
    "- run `source ~/.bash_profile` to activate the changes you just made\n",
    "\n",
    "<img src=\"https://raw.githubusercontent.com/learn-co-curriculum/dsc-data-science-env-config/master/images/mac-bash-set-default-env.png\" width=\"450\">\n",
    "\n",
    "> (Don't forget to run `source ~/.bash_profile` like the Test Student in the screen capture!)\n",
    "\n",
    "If the response ends in `zsh`:\n",
    "\n",
    "- run `echo \"conda activate learn-env\" >> ~/.zshrc` to add the configuration to your bash profile\n",
    "- run `source ~/.zshrc` to activate the changes you just made\n",
    "\n",
    "<img src=\"https://raw.githubusercontent.com/learn-co-curriculum/dsc-data-science-env-config/master/images/mac-zsh-set-default-env.png\" width=\"450\">"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "9bff8a6d",
   "metadata": {},
   "source": [
    "### Windows\n",
    "\n",
    "To follow these instructions on a Windows machine you must be using the Git Bash shell it was suggested to install above.\n",
    "\n",
    "1. Run `touch ~/.bash_profile` to create a new file.\n",
    "2. Run `echo \"conda activate learn-env\" >> ~/.bash_profile` to add the configuration to your bash profile\n",
    "3. Run `source ~/.bash_profile` to activate the changes you just made\n",
    "\n",
    "<img src=\"https://raw.githubusercontent.com/learn-co-curriculum/dsc-data-science-env-config/master/images/win_default_env.PNG\" width=\"450\">"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "cd5d1b24",
   "metadata": {},
   "source": [
    "## Updating your Virtual Environment\n",
    "\n",
    "<img src=\"https://imgs.xkcd.com/comics/python_environment_2x.png\" alt=\"xkcd comic about python environments\" width=\"500\">\n",
    "\n",
    "Python packages are constantly updating and changing, and switching between environments, updating or installing new packages, and troubleshooting environment issues will are all necessary skills for when you're a fully-fledged professional data scientist.\n",
    "\n",
    "In general, because we are using Anaconda as our package manager, it is preferable to update or install new packages using `conda` options instead of `pip`.\n",
    "\n",
    "If you are ever concerned about conflicting package versions, just remember that creating a new conda environment is as easy as `conda create --name new-env` - and it is very normal to have different environments with different packages for different purposes. Just remember that you've likely just set up learn-env to activate by default, so you'll need to either change that or activate other environments manually when needed."
   ]
  },
  {
   "cell_type": "markdown",
   "id": "36386ce3",
   "metadata": {},
   "source": [
    "## Configuring your Kernel and Confirming your Configuration\n",
    "\n",
    "Jupyter Notebooks run \"kernels\" - the computational engine used for executing your code. It's important to be running the right kernel within your notebook, otherwise you may get errors stating that you don't have a particular package or have the wrong version of it or even complaints about the version of Python you're running (some packages don't support Python 3.8, for example).\n",
    "\n",
    "Right now, let's check that everything is running properly. In your terminal, run `jupyter notebook`. This should prompt a new browser window to open, at an address that is something like \"localhost:8888\". \n",
    "\n",
    "<img src=\"https://raw.githubusercontent.com/learn-co-curriculum/dsc-data-science-env-config/master/images/jupyter-home-dir.png\" width=\"650\">\n",
    "\n",
    "We'll talk a lot more about Jupyter Notebooks later on in the course, because you'll use them quite a lot! For now, we want to check not only that the terminal shortcut you just used to open a Jupyter Notebook worked, but also that you are running your learn-env kernel in your notebook.\n",
    "\n",
    "You should be able to see learn-env as an option in the two places shown below. If you don't see the learn-env option in those two places:\n",
    "\n",
    "- Close the notebook in the browser\n",
    "- Close down the notebook server from the terminal\n",
    "    - (run `ctrl` + `c` and then type `y` to confirm that you want to close down jupyter)\n",
    "- In the terminal, enter \n",
    "\n",
    "```bash\n",
    "conda activate learn-env\n",
    "python -m ipykernel install --user --name learn-env --display-name \"Python (learn-env)\"\n",
    "```\n",
    "\n",
    "That will add the learn-env to your list of kernels. When you restart the Jupyter Notebook server and try again, you'll be able to select the learn-env option in these two places:\n",
    "\n",
    "- When you create a new Jupyter Notebook, by clicking \"New\" on the right-hand side\n",
    "\n",
    "<img src=\"https://raw.githubusercontent.com/learn-co-curriculum/dsc-data-science-env-config/master/images/check-kernel1.png\" width=\"650\">\n",
    "\n",
    "- Once you're in a notebook or create a new one, by checking the options under \"Kernel\" in the top menu bar\n",
    "\n",
    "<img src=\"https://raw.githubusercontent.com/learn-co-curriculum/dsc-data-science-env-config/master/images/check-kernel2.png\" width=\"650\">\n",
    "\n",
    "It will be essential to run `conda activate learn-env` every time you start a new terminal window if you do not set your terminal to activate that environment by default. If you don't do this you **will** get errors, so please check this first. You can always run `conda info --envs` to see which environment is selected - and, if you run the above steps to set the learn-env to open by default, you won't need to remember to activate every time you open your terminal."
   ]
  },
  {
   "cell_type": "markdown",
   "id": "502e9e6e",
   "metadata": {},
   "source": [
    "## Summary\n",
    "\n",
    "Congratulations! That was a lot! If you've gotten this far and everything has worked, you have successfully set up your computer with some of the primary tools you need to work as a professional data scientist!"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python (learn-env)",
   "language": "python",
   "name": "learn-env"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.9.16"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}