https://github.com/cnpem/sophys-common

A collection of Bluesky and Ophyd utility code for SIRIUS beamlines and support groups
https://github.com/cnpem/sophys-common

bluesky kafka ophyd sophys

Last synced: about 1 month ago
JSON representation

A collection of Bluesky and Ophyd utility code for SIRIUS beamlines and support groups

• Host: GitHub
• URL: https://github.com/cnpem/sophys-common
• Owner: cnpem
• License: lgpl-3.0
• Created: 2024-12-13T12:25:56.000Z (about 1 month ago)
• Default Branch: main
• Last Pushed: 2024-12-18T17:36:34.000Z (about 1 month ago)
• Last Synced: 2024-12-18T18:36:12.516Z (about 1 month ago)
• Topics: bluesky, kafka, ophyd, sophys
• Language: Python
• Homepage: https://cnpem.github.io/sophys-common/
• Size: 452 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# sophys-common

A collection of [Bluesky](https://blueskyproject.io) and [Ophyd](https://blueskyproject.io/ophyd) utility code (plans, devices, and other useful stuff) for usage at LNLS/SIRIUS beamlines.

Sophys stands for **S**irius **Oph**yd and Bluesk**y** utilitie**s**. As an old wise monk once said, nothing beats a cool-looking name.

## Installation

This package can be installed via `pip`, via the normal procedure.

## Development

This package uses [`pre-commit`](https://pre-commit.com/) to ensure linting and formatting standards. For local development, it is recommended to install the package with `pip install -e ".[dev]"`, which already installs `pre-commit`, as well as `pytest`. Next, you should run `pre-commit install` so that it checks for formatting and linting mistakes before making a new commit, so you don't forget!

#### Documentation

There's also an HTML documentation, located at the `docs/` subdirectory. It uses sphinx, and some plugins, to do the job.

The online version is located at https://cnpem.github.io/sophys-common/. It is updated manually by a maintainer, usually right after a release or a major change.

To build it locally, go inside the `docs/` folder, where there's a `docs-requirements.txt` file containing the building dependencies. Install those requirements (e.g. via `pip install -r docs-requirements.txt`), and run `make html` to generate the built page. You can access the final result by opening `build/html/index.html`.