sdds

Python 3 package to handle SDDS files

https://github.com/pylhc/sdds

Science Score: 59.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
    Found 3 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    2 of 7 committers (28.6%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.7%) to scientific vocabulary

Keywords

python read-write sdds sdds-format

Keywords from Contributors

cern omc optics particle-accelerators lhc pylhc commandline-calls generic-parser ini-parser accelerator-physics
Last synced: 6 months ago · JSON representation

Repository

Python 3 package to handle SDDS files

Basic Info
Statistics
  • Stars: 9
  • Watchers: 19
  • Forks: 4
  • Open Issues: 3
  • Releases: 9
Topics
python read-write sdds sdds-format
Created about 7 years ago · Last pushed 7 months ago
Metadata Files
Readme Changelog License Zenodo

README.md

SDDS

Cron Testing Code Climate coverage Code Climate maintainability (percentage) <!-- GitHub last commit --> PyPI Version GitHub release Conda-forge Version DOI

This package provides reading and writing functionality for self describing data sets (sdds) files. On the python side, the data is stored in a class structure with attributes corresponding to the sdds-format itself (see sdds-format).

See the API documentation for details.

Installing

Installation is easily done via pip: bash python -m pip install sdds

One can also install in a conda environment via the conda-forge channel with: bash conda install -c conda-forge sdds

Example Usage

```python import sdds

sddsdata = sdds.read("pathtoinput.sdds") sdds.write(sddsdata, "pathtooutput.sdds") ```

Read files with different endianness

By default the endianness (byte order) of the file is determined either by a comment !# little-endian or !# big-endian in the header of the file. If this comment is not found, the endianness of the running machine is assumed.

One can force a certain kind of endianness to the reader by supplying it to the read function:

```python import sdds

sddsdata = sdds.read("pathtoinputwithbigendian.sdds", endianness="big") sddsdata = sdds.read("pathtoinputwithlittleendian.sdds", endianness="little") ```

Be aware that sdds.write will always write the file in big-endian order and will also leave a comment in the file, so that the reader can determine the endianness and there is no need to supply it when reading a file written by this package.

Known Issues

  • Can't read binary columns
  • No support for &include tag

License

This project is licensed under the MIT License - see the LICENSE file for details.

Owner

  • Name: PyLHC
  • Login: pylhc
  • Kind: organization
  • Location: CERN

Organisation for the OMC Team at CERN, in BE-ABP-LNO.

GitHub Events

Total
  • Push event: 2
  • Pull request review comment event: 1
  • Pull request review event: 2
  • Pull request event: 2
Last Year
  • Push event: 2
  • Pull request review comment event: 1
  • Pull request review event: 2
  • Pull request event: 2

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 41
  • Total Committers: 7
  • Avg Commits per committer: 5.857
  • Development Distribution Score (DDS): 0.634
Past Year
  • Commits: 5
  • Committers: 2
  • Avg Commits per committer: 2.5
  • Development Distribution Score (DDS): 0.2
Top Committers
Name Email Commits
Felix Soubelet 1****t@u****m 15
JoschD j****y@g****m 14
JoschD 2****D@u****m 6
Joschua Werner Dilly j****y@c****h 2
Mäel Le Garrec m****c@c****h 2
Jaime Coello de Portugal j****9@g****m 1
Maël Le Garrec m****l@l****g 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 28
  • Total pull requests: 37
  • Average time to close issues: 2 months
  • Average time to close pull requests: 5 days
  • Total issue authors: 10
  • Total pull request authors: 5
  • Average comments per issue: 1.14
  • Average comments per pull request: 0.49
  • Merged pull requests: 35
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 2
  • Pull requests: 2
  • Average time to close issues: about 5 hours
  • Average time to close pull requests: about 13 hours
  • Issue authors: 2
  • Pull request authors: 2
  • Average comments per issue: 4.5
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • JoschD (10)
  • fsoubelet (8)
  • Mael-Le-Garrec (3)
  • tiansk (1)
  • pbelange (1)
  • Dronakurl (1)
  • mulingLHY (1)
  • lnevay (1)
  • chernals (1)
  • veprbl (1)
Pull Request Authors
  • fsoubelet (18)
  • JoschD (17)
  • Mael-Le-Garrec (3)
  • Dronakurl (2)
  • jaimecp89 (1)
Top Labels
Issue Labels
enhancement (10) bug (8) Feature Request (3) documentation (2) good first issue (2) help wanted (2) question (1) Type: Bug (1)
Pull Request Labels
enhancement (10) bug (10) documentation (4) Feature Request (3) CI/CD (2) Estimate: Normal (1) Status: Review Needed (1) Type: Maintenance (1)

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 3,245 last-month
  • Total dependent packages: 4
    (may contain duplicates)
  • Total dependent repositories: 2
    (may contain duplicates)
  • Total versions: 14
  • Total maintainers: 1
pypi.org: sdds

SDDS file handling.

  • Versions: 11
  • Dependent Packages: 3
  • Dependent Repositories: 1
  • Downloads: 3,245 Last month
Rankings
Dependent packages count: 2.4%
Downloads: 4.9%
Average: 13.8%
Stargazers count: 17.7%
Dependent repos count: 21.6%
Forks count: 22.7%
Maintainers (1)
Last synced: 7 months ago
conda-forge.org: sdds

A Python package for I/O functionality with SDDS files.

  • Versions: 3
  • Dependent Packages: 1
  • Dependent Repositories: 1
Rankings
Dependent repos count: 24.4%
Dependent packages count: 29.0%
Average: 43.3%
Stargazers count: 57.4%
Forks count: 62.4%
Last synced: 6 months ago

Dependencies

.github/workflows/coverage.yml actions
.github/workflows/cron.yml actions
.github/workflows/documentation.yml actions
.github/workflows/publish.yml actions
.github/workflows/tests.yml actions
setup.py pypi