Installation#
VocalPy can be installed with either one of two package managers: pip or conda. The next section shows commands for installing with either.
It is recommended to always use a virtual environment [1][2][3][4]. For convenience, we also provide commands to create a new environment and install VocalPy into it below.
Which version of Python do I need?
Roughly speaking, you can use any of the latest 3 micro versions. As of January 2024, that would be Python 3.10-3.12. That’s because VocalPy depends on the core scientific Python packages, that have adopted a policy of dropping support for Python versions 3 years after their initial release. For more detail, see SPEC0.
Install vocalpy with pip or conda#
To install VocalPy, copy and paste one of the commands below in the terminal.
python -m pip install vocalpy
conda install vocalpy -c conda-forge
Create a new virtual environment and install VocalPy#
Tip
If you are using conda to create the virtual environment, then you should install VocalPy with conda. (If you need to reproduce an environment, for example on different computers, then pip should only be used after conda [5].)
With venv and pip#
python3 -m venv .venv
source .venv/bin/activate
python3 -m pip install vocalpy
python -m venv .venv
.venv\Scripts\activate
python -m pip install vocalpy
With conda#
conda create --n vocalpy python=3.11
conda activate vocalpy
conda install vocalpy -c conda-forge