Installation

Base Install

We always recommend installing packages inside of your virtual environment of choice. E.g.,

python -m venv venv
. venv/bin/activate

Once your virtual environment is activated, install ProxyStore with pip.

pip install proxystore

Extras Options

The base installation is designed to be as lightweight as possible, but ProxyStore provides many features with extra dependencies that can be installed with the appropriate extras option.

Install	Purpose
pip install proxystore[all]	Install all extras
pip install proxystore[endpoints]	Use ProxyStore Endpoints
pip install proxystore[kafka]	Use Kafka stream shims
pip install proxystore[redis]	Use Redis stream shims or the RedisConnector
pip install proxystore[zmq]	Use ZeroMQ stream shims or the ZeroMQConnector

Multiple extras options can be installed at the same time.

pip install proxystore[endpoints,redis]

Or everything can be installed at once (this does not install the development packages).

pip install proxystore[all]

Note

Some features depend on packages which cannot be installed with pip. For example, the DAOSConnector requires PyDAOS which is installed alongside DAOS. See the DAOS guide for details.