PyCharm 2020.3 Help

Configure a Conda virtual environment

PyCharm supports creating virtual environments for Python with Conda. The following procedure applies to all supported operating systems. Use the platform switcher at the top of this page to view shortcuts specific to your operating system.

Creating a Conda environment

To create a Conda environment

  1. Ensure that Anaconda or Miniconda is downloaded and installed on your computer, and you're aware of a path to its executable file.

    Refer to the installation instructions for more details.

  2. Press Ctrl+Alt+S to open the project Settings/Preferences.

  3. In the Settings/Preferences dialog Ctrl+Alt+S, select Project <project name> | Python Interpreter. Click the The Configure project interpreter icon and select Add.

    Selecting the Add command to create a new Python interpreter
  4. In the left-hand pane of the Add Python Interpreter dialog, select Conda Environment. The following actions depend on whether the Conda environment existed before.

    If New environment is selected:

    1. Specify the location of the new Conda environment in the text field, or click Conda environment location and find location in your file system. Note that the directory where the new Conda environment should be located, must be empty!

    2. Select the Python version from the list.

    3. Specify the location of the Conda executable file in the text field, or click Conda executable location and find location in the Conda installation directory. You're basically looking for a path that you've used when installing Conda on your machine.

    4. Select the Make available to all projects checkbox, if needed.

    If Existing environment is selected:

    1. Expand the Interpreter list and select any of the existing interpreters. Alternatively, click Select an interpreter and specify a path to the Conda executable in your file system, for example, C:\Users\jetbrains\Anaconda3\python.exe.

    2. Select the checkbox Make available to all projects, if needed.

  5. Click OK to complete the task.

PyCharm can create a Conda environment for your project based on the environment.yml file.

Create a Conda environment using the environment.yml file

  1. Open any directory with your source files that contains the environment.yml file: select File | Open from the main menu and choose the directory.

  2. If no Conda environment has been created for this project, PyCharm suggests creating it:

    Create a Conda environment using the requirements.txt file

  3. Keep the suggested options, or specify an alternative Conda executable. Click OK to complete the task.

Once you click OK, PyCharm creates an environment and installs all the required packages.

Note that if you ignore a suggestion to create a Conda environment, PyCharm won't create a Python interperter for your project. So, any time when you open a .py file, you'll see the warning with the options for configuring a project interpreter:

Warning with options for configuring a project interpreter

For any of the configured Python interpreters (but Docker-based), you can:

Last modified: 19 March 2021