Installation¤
The following platforms are officially supported (tested):
- Python: 3.11
- Operating System: Ubuntu Linux 20.04
- Architectures: amd64, arm64
Note
Newer Python versions and other operating systems and architectures might work too, but they are not automatically tested, so we cannot guarantee it.
Installation¤
First, you need to make sure you have Python installed (at least version 3.11):
Note
These instructions assume you are using a POSIX compatible
sh
shell.
If that command doesn't print a version newer than 3.11.0, you'll need to download and install Python first.
To install Frequenz Channels, you probably want to create a new virtual environment first:
Tip
Using direnv
can greatly simplify this process as
it automates the creation, activation, and deactivation of the virtual
environment. The first time you enable direnv
, the virtual environment
will be created, and each time you enter or leave a subdirectory, it will be
activated and deactivated, respectively.
sudo apt install direnv # if you use Debian/Ubuntu
mkdir my-channels-project
cd my-channels-project
echo "layout python python3" > .envrc
direnv allow
This will create the virtual environment and activate it automatically for you.
Now you can install Frequenz Channels by using pip
(if you don't have pip
installed
you can follow the official instructions):
To verify that the installation worked, you can invoke the Python interpreter and
import the frequenz.channels
module: