(install-miniconda)= # Miniconda Installation Miniconda is smaller version of Anaconda that is very quick and easy to install. Like Anaconda, it contains the essential tools to start working with Python: `conda`, Python and a few related packages. You can read more about it on the [Miniconda website](https://docs.anaconda.com/miniconda/). The screenshots in these instructions were made using the Command Prompt on a Windows Operating System (screenshots are from Windows 10). Where needed, instructions and notes for Mac users are provided in addition. ```{tip} Unless you have installed Anaconda or Miniconda recently (e.g., within the last 2-3 years), we recommend you completely remove older versions of these software distributions from your computer and start from scratch. While it is possible to upgrade them, in our experience it is usually faster and less problematic to simply reinstall. ``` ## Download and Installation As described on the [Miniconda website installer page](https://docs.anaconda.com/miniconda/#quick-command-line-install), Miniconda can be installed by running the following in the Windows Command Prompt: % Robert tested Aug-24 Windows 10; this worked very quick and easily `````{tab-set} ````{tab-item} Windows As described on the Miniconda site, _these three commands quickly and quietly download the latest 64-bit Windows installer, rename it to a shorter file name, silently install, and then delete the installer._ Open the command prompt by searching for `cmd` in the start menu. ``` curl https://repo.anaconda.com/miniconda/Miniconda3-latest-Windows-x86_64.exe -o miniconda.exe start /wait "" miniconda.exe /S del miniconda.exe ``` ```{admonition} Tip :class: tip Note that depending on your Windows settings `CTRL+V` does not always work; you may need to use the menu bar of the terminal window or right-click and select paste. In addition, the paste feature typically works one line at a time, therefore after the first line is executed (download) you may need to hit enter once or twice to complete the last lines, as they may not execute automatically. ``` ```{figure} https://github.com/TUDelft-MUDE/source-files/raw/main/file/miniconda_install.png --- height: 200px name: miniconda_install --- Command line installation of Miniconda (Windows). ``` **Make sure `conda.exe` is available on your system `PATH`** On a Windows machine the Command Prompt doesn't know where to find the executable file `conda.exe` you just installed. You can resolve this in two simple steps: 1) find the location of `conda.exe` on your computer, and 2) add the location to the `PATH` environment variable. These two steps are described below 1. Find the location of `conda.exe` on your computer. The executable file `conda.exe` is what allows you to run the command `conda` from a CLI. The default location of this file is in your computer user settings: `C:/Users//miniconda3/`. Inside this folder you should see a number of files, one of which is a subdirectory `./Scripts/`; inside this folder are a number of executables, one of which is `conda.exe`. Therefore, the complete path to `conda` is usually this: ```none C:\Users\\miniconda3\Scripts\conda.exe ``` ```{tip} Can't find the file and folders described above? Check out the {ref}`Hidden Files and Folders page`! ``` 2. Tell your computer how to find `conda.exe` This is described on a **separate page:** {ref}`environment variable instructions for Windows OS `. ```` ````{tab-item} Mac % Isabel tested Sep-2 MacBook pro M1; this worked very quick and easily As described on the Miniconda site, _these four commands download the latest M1 version of the MacOS installer, rename it to a shorter file name, silently install, and then delete the installer._ This can be done from the terminal. You can open Terminal by navigating to Applications > Utilities > Terminal or by searching for "Terminal" using Spotlight `Cmd + Space`. Or you can use your terminal in VS Code. ``` mkdir -p ~/miniconda3 curl https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-arm64.sh -o ~/miniconda3/miniconda.sh bash ~/miniconda3/miniconda.sh -b -u -p ~/miniconda3 rm ~/miniconda3/miniconda.sh ``` ```` ````` ## Check Whether Installation Was Successful Before moving on, you should verify that the installation worked properly. A "successful" installation implies that the `conda` application is accessible on your CLI; this is required for some IDE's to work properly (e.g., VS Code). The easiest way to check if everything worked properly is to make sure that the `conda` command line tool can be found and executed on your system, which can be done by opening the command prompt and typing `conda --version` (note the two dashes, `--`, not one, `-`!). Depending on your operating system and CLI; the following code snippet illustrates the command and response in Windows Command Prompt: ```none C:\Users\YOUR_USERNAME>conda --version conda ``` ```{admonition} Note to Windows Users :class: tip There is a difference between the Command Prompt and the Anaconda version of the Command Prompt (Anaconda Prompt). Make sure `conda` is accessible on the "normal" Command Prompt. As it is made accessible in Anaconda Prompt by default during the installation process, it does not confirm whether or not `conda` is also added to the `PATH` variable for your computer. ``` ## Using Anaconda Prompt Now that Miniconda is installed on your system, from now on we will use the Anaconda Prompt instead of the windows command prompt; this way instructions will be identical regardless of whether you are using Windows or Mac OS! `````{tab-set} ````{tab-item} Windows OS Open the Windows tool bar and begin typing "Anaconda". You should soon see two options appear: "Anaconda Prompt" and "Anaconda PowerShell Prompt." There two versions are based on the two primary CLI's on Windows: Command Prompt and PowerShell. Unless you are an experienced PowerShell user, we recommend using the Command Prompt version: Anaconda Prompt (see figure below): ```{figure} https://github.com/TUDelft-MUDE/source-files/raw/main/file/anaconda_prompt_open_windows.png --- width: 60% name: anaconda_prompt_open_windows --- Open Anaconda Prompt from the Windows menu. ``` ```` ````{tab-item} Mac OS For Mac users this is all made a bit easier. You can just use your Terminal to interact with Anaconda. To activate your Conda environment(by default your base environment) use the following command: ```none conda activate ``` ```` ````` You can now use conda and all the packages within it! % can add gif showing all these commands %```{figure} figures/.png %--- %height: 200px %name: %--- % %```