Skip to main content

Infrastructure components for automated data processing at Diamond Light Source

Project description


PyPI release Conda version Build status Language grade: Python Total alerts Documentation status Supported Python versions Code style: black BSD license

Zocalo is an automated data processing system designed at Diamond Light Source. This repository contains infrastructure components for Zocalo.

The idea of Zocalo is a simple one - to build a messaging framework, where text-based messages are sent between parts of the system to coordinate data analysis. In the wider scope of things this also covers things like archiving, but generally it is handling everything that happens after data aquisition.

Zocalo as a wider whole is made up of two repositories (plus some private internal repositories when deployed at Diamond):

  • DiamondLightSource/python-zocalo - Infrastructure components for automated data processing, developed by Diamond Light Source. The package is available through PyPi and conda-forge.

  • DiamondLightSource/python-workflows - Zocalo is built on the workflows package. It shouldn’t be necessary to interact too much with this package, as the details are abstracted by Zocalo. workflows controls the logic of how services connect to each other and what a service is, and actually send the messages to a message broker. Currently this is an ActiveMQ broker (via STOMP) but support for a RabbitMQ broker (via pika) is being added. This is also available on PyPi and conda-forge.

As mentioned, Zocalo is currently built on top of ActiveMQ. ActiveMQ is an apache project that provides a message broker server, acting as a central dispatch that allows various services to communicate. Messages are plaintext, but from the Zocalo point of view it’s passing aroung python objects (json dictionaries). Every message sent has a destination to help the message broker route. Messages may either be sent to a specific queue or broadcast to multiple queues. These queues are subscribed to by the services that run in Zocalo. In developing with Zocalo, you may have to interact with ActiveMQ or RabbitMQ, but it is unlikely that you will have to configure it.

Zocalo allows for the monitoring of jobs executing python-workflows services or recipe wrappers. The python-workflows package contains most of the infrastructure required for the jobs themselves and more detailed documentation of its components can be found in the python-workflows GitHub repository and the Zocalo documentation.



0.29.0 (2023-06-02)

  • Expose url, version, user_name and user_token attributes on SlurmRestApi instances

  • Load user_token from external file in SlurmRestApi rather than in the zocalo.configuration Slurm plugin to allow token changes to be picked up without re-loading zocalo.configuration

0.28.0 (2023-03-20)

  • Add minimal wrapper for the Slurm REST API to allow job submission

  • Add Slurm zocalo.configuration plugin

0.27.0 (2023-03-16)

  • Add Dockerfile and build-and-push-docker-image GitHub workflow

  • Add zocalo.pickup command for re-submitting messages stored in the zocalo.go.fallback_location while the message broker is unavailable

0.26.0 (2022-11-04)

  • Add dispatcher service

  • Add support for Python 3.11

0.25.1 (2022-10-19)

  • JSONLines service: trigger process_messages immediately when reaching 100 stored messages

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

zocalo-0.29.0.tar.gz (181.0 kB view hashes)

Uploaded source

Built Distribution

zocalo-0.29.0-py3-none-any.whl (64.0 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page