...
- Log on to your SAIL desktop.
- Click on the Start menu (the little Windows icon on the bottom left) → Anaconda3 (64-bit) → Anaconda Prompt (Anaconda3). This will open a command line window with a line of text like:
- (base) C:\Users\<your username will be here>
- Now we need to make an environment to use. In this command line window, type the following and then hit 'Enter':
conda create -p P:\<your username here>\<name of your new environment> –-channel=anaconda --channel=conda-forge nb_conda_kernels pandas numpy jupyterlab
- For example, if my username is 'leal' and I want to create an environment called 'mynewenv' in a folder called 'conda-envs', the command I would run would be:
conda create -p P:\leal\conda-envs\mynewenv –-channel=anaconda --channel=conda-forge nb_conda_kernels pandas numpy jupyterlab
- Wait a little while until the window asks you whether to proceed - hit 'y' on your keyboard and then press 'Enter'.
- Wait while your new environment is created and all requested packages are installed.
- You might get a pop-up saying, "this app has been blocked by your system administrator" this is fine, and it all worked. Just click 'Close' on the message.
- After your environment is created, you need to activate it by typing the following in the same command line window:
conda activate P:\<your username here>\<name of your new environment>
- So, if my username is 'leal' and I created an environment called 'mynewenv' in a folder called 'conda-envs', I would use the command:
conda activate P:\leal\conda-envs\mynewenv
- You'll know when the environment is activated because , as in the image above, the environment name and path will be in brackets as in the image above.
- Congratulations, you can now move on to the next part of the guide.
Starting Jupyter
This assumes that you have done the initial setup and have an environment saved on your P: (pronounced 'P drive').
...
Special steps for R users
If you want to use R in a Jupyter environment, then you will need to follow the below steps rather than the above steps for Python. By following these instructions, your R packages will be successfully installed into your created Anaconda environment rather than in a shared location that RStudio uses, which can cause problems down the line.
- Log on to your SAIL desktop.
- Click on the Start menu (the little Windows icon on the bottom left) → Anaconda3 (64-bit) → Anaconda Prompt (Anaconda3). This will open a command line window with a line of text like:
- (base) C:\Users\<your username will be here>
- conda activate
- Now we need to make an environment to use. In this command line window, type the following and then hit 'Enter':
conda create -p P:\<your username here>\<name of your new environment>
- So, if my username is 'leal' and I created an environment called 'mynewenv' in a folder called 'conda-envs', I would use the command:
conda activate P:\leal\conda-envs\mynewenv
- You will know when the environment is activated because the window will show a line of text like:
- (P:\<your username>\<your environment name>) C:\Users\<your username>
–-channel=anaconda --channel=conda-forge --channel=r r-base=4.1.3 r-irkernel nb_conda_kernels jupyterlab r-essentials
- For example, if my username is 'leal' and I want to create an environment called 'renv' in a folder called 'conda-envs', the command I would run would be:
conda create -p P:\leal\conda-envs\renv –-channel=anaconda --channel=conda-forge --channel=r r-base=4.1.3 r-irkernel nb_conda_kernels jupyterlab r-essentials
- Wait a little while until the window asks you whether to proceed - hit 'y' on your keyboard and then press 'Enter'.
- Wait while your new environment is created and all requested packages are installed.
- After your environment is created, you need to activate it by typing the following in the same command line window:
conda activate P:\<your username here>\<name of your new environment>
- So, if my username is 'leal' and I created an environment called 'renv' in a folder called 'conda-envs', I would use the command:
conda activate P:\leal\conda-envs\renv
- You'll know when the environment is activated because the environment name and path will be in brackets as in the image above.
- Next, you need to install a package that will force R to look in your Anaconda environment for installed packages. To do this, in the same command line window we've been using, type the following and hit 'Enter':
conda install -c conda-forge conda-ecosystem-user-package-isolation
- Type 'y' to agree to the installation and wait while it completes.
- Your Anaconda window will probably go a bit weird after installing that last one, so just quit it (click the "X" in the top right) and then launch a new Anaconda Prompt window (as in step 2).
- Activate your env where we've installed these new things using:
conda activate
P:\<your username here>\<name of your new environment>
- So, if my username is 'leal' and I created an environment called 'renv' in a folder called 'conda-envs', I would use the command:
conda activate P:\leal\conda-envs\renv
- You'll know when the environment is activated because the environment name and path will be in brackets as in the image above.
- Congratulations! You can now move on to the "Starting Jupyter" section.
Starting Jupyter
This assumes you have done the initial setup and saved an environment on your P: (pronounced 'P drive').
Suppose you've just completed the initial setup and have your new environment activated in an open command line window. In that case, you can skip steps 1-3.
- Log on to your SAIL desktop.
- Click on the Start menu (the little Windows icon on the bottom left) → Anaconda3 (64-bit) → Anaconda Prompt (Anaconda3). This will open a command line window with a line of text like:
- (base) C:\Users\<your username will be here>
- Activate your conda environment by typing the following in the same command line window:
conda activate P:\<your username here>\<name of your new environment>
- So, if my username is 'leal' and I created an environment called 'mynewenv' in a folder called 'conda-envs', I would use the command:
conda activate P:\leal\conda-envs\mynewenv
- You will know when the environment is activated because the window will show a line of text like:
- (P:\<your username>\<your environment name>) C:\Users\<your username>
- VERY IMPORTANT: Before starting Jupyter, we must ensure we're on the P: in the command line window. To do this, type the following into the window and press Enter:
P:
- Then type the following and press Enter:
cd <your username here>
- So if my username is 'leal', I would type:
cd leal
- (Optional) You might want to navigate to the specific folder in which you'll be working/saving this work, but that is out of the scope of this simple guide.
- We are now ready to start Jupyter. In the command line window, type and hit Enter with either of the following commands:
jupyter notebook
- This will give you the 'classic' Jupyter interface.
jupyter lab
- This gives you a more modern Jupyter interface.
- Jupyter will automatically open in a Microsoft Edge tab. You can navigate wherever you want to save your notebooks, create folders, make your notebooks, etc.
- You need to must leave the Anaconda Prompt window open while you're using Jupyter.
- To ensure that you're using the correct environment kernel in Jupyter, you need to pay attention when creating notebooks.
- Log on to your SAIL desktop.
- Click on the Start menu (the little Windows icon on the bottom left) → Anaconda3 (64-bit) → Anaconda Prompt (Anaconda3). This will open a command line window with
- In the 'classic' interface:
- Click on 'New' in the top right.
- In the drop-down window that opens, make sure you choose the option called
Python \[conda env: <name of your conda env here>\]*
- In the modern interface:
- Under the 'Notebook' heading in the launcher tab, select the one with the name
Python \[conda env: <name of your conda env here>\]*
- Under the 'Notebook' heading in the launcher tab, select the one with the name
- In the 'classic' interface:
- When you're done and want to exit Jupyter, click on the 'Anaconda Prompt' window on the taskbar, click somewhere in the window, and press Ctrl+C twice.
- Please wait a few seconds; Jupyter should shut down, making it safe to close your notebook.
Installing packages
This assumes that you've completed the initial setup and have an environment saved on your P: .
Suppose you've just completed the initial setup and have your new environment activated in an open command line window. In that case, you can skip steps 1-3.
We strongly recommend users try installing from Anaconda sources for package installation. You should only use pip if a package isn't available from Anaconda channels.
- In the modern interface:
- Under the 'Notebook' heading in the launcher tab, select the one with the name
Python \[conda env: <name of your conda env here>\]*
- Under the 'Notebook' heading in the launcher tab, select the one with the name
- When you're done and want to exit Jupyter, click on the 'Anaconda Prompt' window on the taskbar, click somewhere in the window, and press Ctrl+C twice.
- Please wait a few seconds; Jupyter should shut down, making it safe to close your notebook.
Installing packages
This assumes you've completed the initial setup and have an environment saved on your P: .
Suppose you've just completed the initial setup and have your new environment activated in an open command line window. In that case, you can skip steps 1-3.
We strongly recommend users try installing from Anaconda sources for package installation. You should only use pip if a package isn't available from Anaconda channels.
- Log on to your SAIL desktop.
- Click on the Start menu (the little Windows icon on the bottom left) → Anaconda3 (64-bit) → Anaconda Prompt (Anaconda3). This will open a command line window with a line of text like:
- (base) C:\Users\<your username will be here>
- Activate your conda environment by typing the following in the same command line window:Your package is installed!
conda activate P:\<your username here>\<name of your new environment>
- So, if my username is 'leal' and I created an environment called 'mynewenv' in a folder called 'conda-envs', I would use the command:
conda activate P:\leal\conda-envs\mynewenv
- You will know when the environment is activated because the window will show a line of text like:
- (
- Activate your conda environment by typing the following in the same command line window:
conda activate P:\<your username here>\<name of your new environment>
- So, if my username is 'leal' and I created an environment called 'mynewenv' in a folder called 'conda-envs', I would use the command:
conda activate P:\leal\conda-envs\mynewenv
- You will know when the environment is activated because the window will show a line of text like:
- (P:\<your username>\<your environment name>) C:\Users\<your username>
- Outside your SAIL desktop, go to Google and search '<name of the package you want to install> anaconda'.
- For example, if I want to install the package 'recordlinkage', I would search on Google for 'recordlinkage anaconda'.
- Select the Google result from anaconda.org; this should take you directly to the Anaconda page for the package.
- On the page, there will be a command that tells you how to install it. Sticking with the recordlinkage example, the webpage shows me that the command to install is:
conda install -c conda-forge recordlinkage
- Go back to your SAIL desktop and type this installation command into your Anaconda Prompt window, hitting 'Enter'.
- Wait for Anaconda to ask you if you want to proceed - hit 'y' on your keyboard and then press 'Enter'.
- P:\<your username>\<your environment name>) C:\Users\<your username>
- Outside your SAIL desktop, go to Google and search '<name of the package you want to install> anaconda'.
- For example, if I want to install the package 'recordlinkage', I would search on Google for 'recordlinkage anaconda'.
- Select the Google result from anaconda.org; this should take you directly to the Anaconda page for the package.
- On the page, a command will tell you how to install it. Sticking with the recordlinkage example, the webpage shows me that the command to install is:
conda install -c conda-forge recordlinkage
- Return to your SAIL desktop and type this installation command into your Anaconda Prompt window, hitting 'Enter'.
- Wait for Anaconda to ask you if you want to proceed - hit 'y' on your keyboard and then press 'Enter'.
- Your package is installed!
Installing packages in R using install.packages()
This assumes you've completed the initial setup and have an environment saved on your P: .
We strongly recommend users try installing from Anaconda sources for package installation. You should only use CRAN if a package isn't available from Anaconda channels.
- Complete steps 1-9 in the "Starting Jupyter" section above.
- In the Jupyter Notebook that launched when you clicked on the card with the title:
R \[conda env: <name of your conda env here>\]*
- Type the following in a cell and execute it:
install.packages("<name of package to install>", repos="http://cran.rstudio.com")
- For example, to install the "rmarkdown" package, you would do
install.packages("rmarkdown", repos="http://cran.rstudio.com")
- Your package is installed!
...
Instructions with explanations
...