PyCharm 2024.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.

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.

    For more information, refer to the installation instructions.

  2. Do one of the following:

    • Click the Python Interpreter selector and choose Add New Interpreter.

    • Press Ctrl+Alt+S to open Settings and go to Project: <project name> | Python Interpreter. Click the Add Interpreter link next to the list of the available interpreters.

    • Click the Python Interpreter selector and choose Interpreter Settings. Click the Add Interpreter link next to the list of the available interpreters.

  3. Select Add Local Interpreter.

  4. The following actions depend on whether you want to create a new conda environment or to use an existing one.

    New conda environment
    Generate new conda environment
    1. Select Conda from the list of environment types.

    2. Select the Python version from the list.

    3. Specify the environment name.

    4. Normally, PyCharm will detect conda installation.

      Otherwise, specify the location of the conda executable, or click Conda executable location to browse for it.

    Existing conda environment
    Select existing conda environment
    1. Select Conda from the list of environment types.

    2. Normally, PyCharm will detect conda installation.

      Otherwise, specify the location of the conda executable, or click Conda executable location to browse for it.

    3. Select the environment from the list.

    The selected conda environment will be reused for the current project.

  5. Click OK to complete the task.

If the directory with your source files contains an environment.yml file, PyCharm can create a conda environment based on it.

Create a conda environment based on environment.yml

  1. Do one of the following:

  2. Browse for the directory which contains your source files and the environment.yml file, and then click Open (on Mac) or OK (on Windows):

    Opening a yml file
  3. If you didn't create a project and configure a Python interpreter in that directory before, PyCharm suggests creating a conda environment:

    Create a Conda environment using the requirements.txt file
  4. 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 interpreter 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: 13 November 2024