• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1PYTHON ENVIRONMENTS
2===================
3
4When you don't want to install Bumble in your main/default python environment,
5using a virtual environment, where the package and its dependencies can be
6installed, isolated from the rest, may be useful.
7
8There are many flavors of python environments and dependency managers.
9This page describes a few of the most common ones.
10
11
12## venv
13
14`venv` is a standard module that is included with python.
15Visit the [`venv` documentation](https://docs.python.org/3/library/venv.html) page for details.
16
17## Pyenv
18
19`pyenv` lets you easily switch between multiple versions of Python. It's simple, unobtrusive, and follows the UNIX tradition of single-purpose tools that do one thing well.
20Visit the [`pyenv` site](https://github.com/pyenv/pyenv) for instructions on how to install
21and use `pyenv`
22
23## Conda
24
25Conda is a convenient package manager and virtual environment.
26The file `environment.yml` is a Conda environment file that you can use to create
27a new Conda environment. Once created, you can simply activate this environment when
28working with Bumble.
29Visit the [Conda site](https://docs.conda.io/en/latest/) for instructions on how to install
30and use Conda.
31A few useful commands:
32
33### Create a new `bumble` Conda environment
34```
35$ conda env create -f environment.yml
36```
37This will create a new environment, named `bumble`, which you can then activate with:
38```
39$ conda activate bumble
40```
41
42### Update an existing `bumble` environment
43```
44$ conda env update -f environment.yml
45```
46