Installation

System Requirements

Supported Python versions: 3.7, 3.8, 3.9.

Installation Steps

  • Install Redis

    Skip this step if Redis is already installed.

    Linux:

    $ sudo apt install redis
    

    Mac OS:

  • Create Conda environment

    It is recommended to install the Queue Server in Conda environment. A new environment can be created or already existing environment can be activated. The following example illustrates how to create a new Conda environment with the name queue_server and Python 3.9 installed:

    $ conda create -n queue_server python=3.9
    $ activate queue_server
    

    The Queue Server currently works with Python 3.7-3.9, but it is recommended that Python 3.9 is used for development.

  • Install Queue Server

    Install from PyPI:

    $ pip install bluesky-queueserver
    

    Install from conda-forge:

    $ conda install bluesky-queueserver -c conda-forge
    

    Install from from source (GitHub repository):

    $ cd <directory-with-git-repositories>
    $ git clone https://github.com/bluesky/bluesky-queueserver.git
    $ cd bluesky-queueserver
    $ pip install -e .
    

    After the installation is completed, users should be able to run start-re-manager, qserver, qserver-list-plans-devices and qserver-zmq-keys tools from command line.