Add conda instruction to "How to Setup a Virtual Python Environment" (#1588)

* Added conda instruction to "How to Setup a Virtual Python Enironment" guide

* Corrected the table of content for "How to Setup a Virtual Python Environment"

* Added one bullet for removing a conda environment.
This commit is contained in:
Hong Chen 2023-10-12 11:26:13 -05:00 committed by GitHub
parent 885639e2b2
commit da0110536e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,7 +1,27 @@
## HOWTO Setup a Python Virtual Environment
# HOWTO Setup a Python Virtual Environment
### Creating a Virtual Environment
- [Using the Built-in venu Module in Python3](#using-the-built-in-venv-module-in-python-3)
* [Creating a Virtual Environment](#creating-a-virtual-environment)
* [Activating the Virtual Environment](#activating-the-virtual-environment)
* [Installing Python Modules Into Your Virtual Environment](#installing-python-modules-into-your-virtual-environment)
* [Deactivating the venv Shell](#deactivating-the-venv-shell)
- [Using Conda](#using-conda)
* [Creating a Conda Environment with Commands](#creating-a-conda-environment-with-commands)
* [Creating a Conda Environment From a YAML File](#creating-a-conda-environment-from-a-yaml-file)
* [Activating the Conda Environment](#activating-the-conda-environment)
* [Installing Packages Into a Conda Environment](#installing-packages-into-a-conda-environment)
* [Deactivating an Active Conda Environment](#deactivating-an-active-conda-environment)
* [Removing a Conda Environment](#removing-a-conda-environment)
- [References](#references)
<!-- toc -->
## [Using the Built-in venv Module in Python 3](#using-the-built-in-venv-module-in-python-3)
### [Creating a Virtual Environment](#creating-a-virtual-environment)
The following command creates a virtual Python environment:
@ -19,7 +39,7 @@ in your home directory.
```% python3 -m venv ~/myVenv```
### Activating the Virtual Environment
### [Activating the Virtual Environment](#activating-the-virtual-environment)
To activate the virtual environment, execute the following:
@ -29,7 +49,7 @@ To activate the virtual environment, execute the following:
Note that the name of virtual environment is added to the command prompt.
### Installing Python Modules Into Your Virtual Environment
### [Installing Python Modules Into Your Virtual Environment](#installing-python-modules-into-your-virtual-environment)
Use the following command to install Python modules into the virtual environment:
@ -47,7 +67,7 @@ This Python module would be installed as follows:
Every time ```myVenv``` is activated, the PyYAML module will be available.
### Deactivating the venv Shell
### [Deactivating the venv Shell](#deactivating-the-venv-shell)
To deactivate the venv shell, execute the following:
```(myVenv) % deactivate```
@ -56,3 +76,110 @@ To deactivate the venv shell, execute the following:
The above should get you going. If you need more details, the following tutorial is pretty good.
[RealPython Tutorial](https://realpython.com/python-virtual-environments-a-primer/).
## [Using Conda](#using-conda)
Conda is a powerful package manager and environment manager that you use with command line commands at the Anaconda Prompt for Windows, or in a terminal window for macOS or Linux.
You can obtain conda by installing [Miniconda](https://docs.conda.io/projects/miniconda/en/latest/) or [Anaconda](https://docs.anaconda.com/free/anacondaorg/).
Miniconda a small bootstrap version of Anaconda that includes only conda, Python, the packages they both depend on, and a small number of other useful packages (like pip, zlib, and a few others).
Anaconda is a downloadable, free, open-source, high-performance, and optimized Python and R distribution. It includes conda, conda-build, Python, and 250+ automatically installed, open-source scientific packages and their dependencies that have been tested to work well together, including SciPy, NumPy, and many others.
### [Creating a Conda Environment with Commands](#creating-a-conda-environment-with-commands)
#### Create a conda virtial environment with Python by running one of following conda commands from a terminal:
```
# A specific version of Python
% conda create --name trick python=3.9.18
or
% conda create -n trick python=3.9.18
# The latest version of Python 3.9
% conda create -n trick python=3.9
# The lastest version of Python
% conda create -n trick python
# The latest version of Python 3.9 and packages
% conda create -n trick python=3.9 pyyaml scipy
```
### [Creating a Conda Environment From a YAML File](#creating-a-conda-environment-from-a-yaml-file)
#### Create the file ```myenv.yml``` with following contents:
```
name: trick
channels:
- conda-forge
- defaults
dependencies:
- python = 3.9
- pyyaml
```
In this example, the environment is named ```trick``` and includes two packages: python and pyyaml.
#### Run conda command to create the new environment:
Once you have your YAML file ready, you can create your conda environment using the following command in your terminal:
```% conda env create -f myenv.yml```
### [Activating the Conda Environment](#activating-the-conda-environment)
After creating the environment, you can activate it using the following command:
```% conda activate trick```
### [Installing Packages Into a Conda Environment](#installing-packages-into-a-conda-environment)
If you're in your conda environment, you can install package(s) using the following command:
``` (trick) % conda install numpy scipy```
If you're NOT in your conda environment, you can install package(s) into a specified environment using the following command:
``` % conda install -n trick numpy scipy```
### [Deactivating an Active Conda Environment](#deactivating-an-active-conda-environment)
If you're in your conda environment, you can deactivate it using the following command:
```(trick) % conda deactivate```
### [Removing a Conda Environment](#removing-a-conda-environment)
You can remove a conda environment from your terminal using the following command:
``` % conda remove -n trick --all```
or
``` % conda env remove -n trick```
To verify that the environment was removed, run following from your terminal:
``` % conda info --envs```
The removed environment should not be shown.
# [References](#references)
* [RealPython Tutorial - Python Virtual Environment: A Primer](https://realpython.com/python-virtual-environments-a-primer/)
* [Conda Document - Managing environments](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html)
* [Creating an environment in Anaconda through a yml file](https://sachinjose31.medium.com/creating-an-environment-in-anaconda-through-a-yml-file-7e5deeb7676d)