Data

Tools

Indexes

Applications

Experiments

Open Source Science

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

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (9.4%) to scientific vocabulary

Keywords

bluesky kafka ophyd sophys
Last synced: 11 months ago · JSON representation

Repository

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

Basic Info
Statistics
  • Stars: 1
  • Watchers: 2
  • Forks: 3
  • Open Issues: 11
  • Releases: 6
Topics
bluesky kafka ophyd sophys
Created over 1 year ago · Last pushed 11 months ago
Metadata Files
Readme License

README.md

sophys-common

A collection of Bluesky and Ophyd utility code (plans, devices, and other useful stuff) for usage at LNLS/SIRIUS beamlines.

Sophys stands for Sirius Ophyd and Bluesky utilities. 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 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.

Owner

  • Name: Brazilian Center for Research in Energy and Materials (CNPEM)
  • Login: cnpem
  • Kind: organization
  • Location: Brazil

GitHub Events

Total
  • Fork event: 3
  • Create event: 20
  • Commit comment event: 1
  • Release event: 5
  • Issues event: 12
  • Watch event: 1
  • Delete event: 14
  • Issue comment event: 20
  • Push event: 92
  • Public event: 1
  • Pull request review comment event: 112
  • Pull request review event: 148
  • Pull request event: 95
Last Year
  • Fork event: 3
  • Create event: 20
  • Commit comment event: 1
  • Release event: 5
  • Issues event: 12
  • Watch event: 1
  • Delete event: 14
  • Issue comment event: 20
  • Push event: 92
  • Public event: 1
  • Pull request review comment event: 112
  • Pull request review event: 148
  • Pull request event: 95

Committers

Last synced: over 1 year ago

All Time
  • Total Commits: 396
  • Total Committers: 5
  • Avg Commits per committer: 79.2
  • Development Distribution Score (DDS): 0.51
Past Year
  • Commits: 377
  • Committers: 4
  • Avg Commits per committer: 94.25
  • Development Distribution Score (DDS): 0.504
Top Committers
Name Email Commits
Sofia Donato Ferreira s****a@l****r 194
Rafael Lyra r****a@l****r 174
igor.torquato@lnls.br i****o@l****r 12
hugo.campos h****s@l****r 12
Marco A. B. Montevechi Filho m****o@l****r 4
Committer Domains (Top 20 + Academic)
lnls.br: 5

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 10
  • Total pull requests: 67
  • Average time to close issues: 27 days
  • Average time to close pull requests: 8 days
  • Total issue authors: 3
  • Total pull request authors: 4
  • Average comments per issue: 0.4
  • Average comments per pull request: 0.21
  • Merged pull requests: 48
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 10
  • Pull requests: 67
  • Average time to close issues: 27 days
  • Average time to close pull requests: 8 days
  • Issue authors: 3
  • Pull request authors: 4
  • Average comments per issue: 0.4
  • Average comments per pull request: 0.21
  • Merged pull requests: 48
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • flowln (7)
  • Igort4 (2)
  • RafaelLyra8 (1)
Pull Request Authors
  • flowln (45)
  • RafaelLyra8 (12)
  • Igort4 (8)
  • Murilo-cnpem (2)
Top Labels
Issue Labels
enhancement (2) breaking change (2) CI (1) bug (1)
Pull Request Labels
enhancement (11) bug (10) documentation (8) CI (7) breaking change (2)

Dependencies

.github/workflows/pre-commit.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5.3.0 composite
  • pre-commit/action v3.0.1 composite
  • tj-actions/changed-files v45.0.5 composite
.github/workflows/testing.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5.3.0 composite
  • spicyparrot/kafka-kraft-action v1.1.3 composite
.github/workflows/documentation.yml actions
  • actions/checkout v4 composite
  • actions/deploy-pages v4 composite
  • actions/setup-python v5.3.0 composite
  • actions/upload-pages-artifact v3 composite
docs/docs-requirements.txt pypi
  • sphinx ==7.2.6
  • sphinx-design ==0.5.0
  • sphinx-remove-toctrees ==0.0.3
  • sphinx-tags ==0.3.1
  • sphinx_rtd_theme ==2.0.0
pyproject.toml pypi
  • bluesky *
  • numpy ==1.26.4
  • ophyd *