Windows 8 (or newer) installation

Machines running recent versions of Windows can run OpenMSIStream programs interactively, or persistently as Windows Services.

Create the Conda Environment

With Miniconda installed, create and activate a dedicated virtual environment for OpenMSI. In a terminal shell (or Anaconda Prompt in admin mode on Windows) type:

conda create -n openmsi python=3.9
conda activate openmsi

You’ll need to use the second command to “activate” the openmsi environment every time you open a Terminal window or Anaconda Prompt and want to work with OpenMSIStream.

Issues with DLL Files

On Windows, you need to set a special variable in the virtual environment to allow the Kafka Python code to find its dependencies (see here for more details). To do this, activate your Conda environment as above then type the following commands to set the variable and then refresh the environment:

conda env config vars set CONDA_DLL_SEARCH_MODIFICATION_ENABLE=1
conda deactivate
conda activate openmsi

Install libsodium

libsodium is a package used for the KafkaCrypto package that provides the end-to-end data encryption capability of OpenMSIStream. Since encryption is a built-in option for OpenMSIStream, you must install libsodium even if you don’t want to use encryption. Install the libsodium package through Miniconda using the shell command:

conda install -c anaconda libsodium

Install OpenMSIStream

You can install the OpenMSIStream code through PyPI:

pip install openmsistream

If you’d like to be able to make changes to the OpenMSIStream code without reinstalling, you can include the --editable flag in the pip install command. If you’d like to run the automatic code tests, build the documentation, or upload new releases to PyPI on your local system, you can install the optional dependencies needed with pip install openmsistream[test], pip install openmsistream[docs], or pip install openmsistream[dev] respectively, with or without the --editable flag. You can install all optional dependencies with pip install openmsistream[all].

This completes installation and will give you access to several new console commands to run OpenMSIStream applications, as well as any of the other modules in the openmsistream package.

If you like, you can check your installation by opening a python prompt and typing:

>>> import openmsistream

and if that line runs without any problems then the package was installed correctly.