zocalo-dls 0.4.0
Standard components for automated data processing with Zocalo at Diamond Light Source
License: BSD license
Keywords: zocalo dls diamond

=============================
Diamond-specific Zocalo Tools
=============================

.. image:: https://img.shields.io/pypi/v/zocalo-dls.svg
           :target: https://pypi.python.org/pypi/zocalo-dls
           :alt: PyPI release

.. image:: https://img.shields.io/pypi/l/zocalo-dls.svg
           :target: https://pypi.python.org/pypi/zocalo-dls
           :alt: BSD license

.. image:: https://github.com/DiamondLightSource/python-zocalo-dls/actions/workflows/python-package.yml/badge.svg
           :target: https://github.com/DiamondLightSource/python-zocalo-dls/actions/workflows/python-package.yml
           :alt: Build status

.. image:: https://img.shields.io/lgtm/grade/python/g/DiamondLightSource/python-zocalo-dls.svg?logo=lgtm&logoWidth=18
           :target: https://lgtm.com/projects/g/DiamondLightSource/python-zocalo-dls/context:python
           :alt: Language grade: Python

.. image:: https://img.shields.io/lgtm/alerts/g/DiamondLightSource/python-zocalo-dls.svg?logo=lgtm&logoWidth=18
           :target: https://lgtm.com/projects/g/DiamondLightSource/python-zocalo-dls/alerts/
           :alt: Total alerts

.. image:: https://readthedocs.org/projects/python-zocalo-dls/badge/?version=latest
           :target: https://python-zocalo-dls.readthedocs.io/en/latest/?badge=latest
           :alt: Documentation status

.. image:: https://img.shields.io/pypi/pyversions/zocalo-dls.svg
           :target: https://pypi.org/project/zocalo-dls/
           :alt: Supported Python versions

.. image:: https://flat.badgen.net/dependabot/DiamondLightSource/python-zocalo-dls?icon=dependabot
           :target: https://github.com/DiamondLightSource/python-zocalo-dls
           :alt: Dependabot dependency updates

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
           :target: https://github.com/ambv/black
           :alt: Code style: black

`Zocalo <https://github.com/DiamondLightSource/python-zocalo/>`_ services and wrappers which can be used across teams at
`Diamond Light Source <https://www.diamond.ac.uk/Home.html/>`_.

There are specialised versions of the services provided by Zocalo, and services
which are useful at Diamond but are not central to Zocalo itself.

Much of the data analysis work at Diamond is directed by and presented to users through `ISPyB <https://ispyb.github.io/ISPyB/>`_.
Therefore, we provide some central services which enable cooperation between the data analysis pipelines and the ISPyB
database at Diamond.

The code in this repository is actively used for processing of many different experiments at Diamond.
The hope is that soon it will be used across many areas of science here and perhaps elsewhere.

Please take this code inspiration for how to implement Zocalo at other facilities.

Installation
------------

.. code-block::

    pip install zocalo-dls


This will add several service and wrapper entry points which should appear with:

.. code-block::

    zocalo.service --help
    zocalo.wrap --help


Contributing
------------

This package is maintained by a core team at Diamond Light Source.

To contribute, fork this repository and issue a pull request.

`Pre-commit <https://pre-commit.com/>`_ hooks are provided, please check code against these before submitting.
Install with:

.. code-block::

    pre-commit install


=======
History
=======

0.3.0 (2019-07-30)
------------------

- Add wrapper to run DAWN
- Add wrapper to run Jupyter notebooks

0.2.0 (2019-07-30)
------------------

- Publish zocalo-dls to pypi.org
- Add ISPyB service

0.1.0 (2019-07-30)
------------------

- Working to set this package up with best practices for Diamond teams to follow
- Generic wrapper for GDA tasks