Installation guide

Murfey package installation

The murfey package is hosted on PyPI and can be installed into a given Python environment via pip:

python -m pip install murfey[client,server]

If the environment is being used for only one of the components then the dependencies installed can be reduced by specifying that component, i.e. if only the server is to be run from that environment:

python -m pip install murfey[server]

We would recommend using a conda environment or similar rather than the system Python.

Environment variables

The Murfey server must be run in an environment with the following environment variables present:

• MURFEY_MACHINE_CONFIGURATION (path to Murfey machine configuration yaml)
• MURFEY_SECURITY_CONFIGURATION (path to Murfey security configuration yaml)
• ZOCALO_CONFIG (path to Zocalo configuration yaml)
• ISPYB_CREDENTIALS (optional, path to ISPyB credentials file)