Data

Tools

Indexes

Applications

Experiments

Open Source Science

eniius

Ultility to embed neutron instrument information using (NX)SPE files.

https://github.com/mducle/eniius

Science Score: 54.0%

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

  • ✓
    CITATION.cff file
    Found 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
    1 of 2 committers (50.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (5.5%) to scientific vocabulary
Last synced: 7 months ago · JSON representation ·

Repository

Ultility to embed neutron instrument information using (NX)SPE files.

Basic Info
  • Host: GitHub
  • Owner: mducle
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 167 KB
Statistics
  • Stars: 1
  • Watchers: 2
  • Forks: 1
  • Open Issues: 0
  • Releases: 3
Created over 3 years ago · Last pushed over 1 year ago
Metadata Files
Readme Changelog License Citation

README.md

eniius

A program for processing neutron data in the tradition of Homer and Horace, eniius is a utility for embedding neutron instrument information using (nx)spe files.

Aims

Proper analysis of inelastic neutron scattering (INS) data requires taking the instrument resolution function into account [1], and this in turn requires particular information about the neutron spectrometer (instrument) recording the data. Hitherto this information has been obtained post-facto from the program(s) performing the resolution convolution.

In the interest of FAIR data and to improve usability, this information should be embedded in the raw datafiles produced by the instrument, and the aim of eniius is to provide a utility for just this purpose.

Features

  • Instrument data is embedded in a NeXus data file as a NXinstrument group.
  • The embedded instrument is at a minimum enough to be imported into Horace for resolution calculation.
  • eniius also has the facility to export this information as McStas instrument files for ray tracing simulations of the resolution function, and can also import certain McStas instrument files to embed in raw data files.
  • Is compatible with the IBEX data acquisition program as well as the Mantid data reduction suite.
  • Has a GUI for visualising the instrument data.

Owner

  • Name: Duc Le
  • Login: mducle
  • Kind: user
  • Location: Harwell, UK
  • Company: Science and Technology Facilities Council

Citation (CITATION.cff) 

cff-version: "1.1.0"
message: "If you have used eniius in your research, please cite it as below"
abstract: "eniius is a utility for embedding neutron instrument information using (nx)spe files."
authors:
  - family-names: "Le"
    given-names: "Manh Duc"
    orcid: "https://orcid.org/0000-0003-3012-6053"
  - family-names: "Tucker"
    given-names: "Gregory S."
    orcid: https://orcid.org/0000-0002-2787-8054
title: "eniius"
version: "0.2.0"
date-released: "2024-04-18"
license: "GPL-3.0-only"
repository: "https://github.com/mducle/eniius"
url: "https://github.com/eniius/eniius"
keywords:
  - "Python"

GitHub Events

Total
Last Year

Committers

Last synced: 8 months ago

All Time
  • Total Commits: 17
  • Total Committers: 2
  • Avg Commits per committer: 8.5
  • Development Distribution Score (DDS): 0.235
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Duc Le d****e@s****k 13
Greg Tucker g****r@g****m 4
Committer Domains (Top 20 + Academic)
stfc.ac.uk: 1

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 3
  • Total pull requests: 14
  • Average time to close issues: 8 days
  • Average time to close pull requests: 11 days
  • Total issue authors: 2
  • Total pull request authors: 2
  • Average comments per issue: 1.33
  • Average comments per pull request: 0.07
  • Merged pull requests: 14
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • g5t (2)
  • ashishbijlani (1)
Pull Request Authors
  • mducle (10)
  • g5t (5)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 16 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 3
  • Total maintainers: 1
pypi.org: eniius

A utility for embedding neutron instrument information using (nx)spe files.

  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 16 Last month
Rankings
Dependent packages count: 10.0%
Dependent repos count: 21.7%
Forks count: 22.6%
Stargazers count: 31.9%
Average: 33.7%
Downloads: 82.4%
Maintainers (1)
mducle
Last synced: 7 months ago

Dependencies

.github/workflows/main.yml actions
  • actions/cache v3 composite
  • actions/checkout v3 composite
  • actions/upload-artifact v3 composite
  • mamba-org/provision-with-micromamba main composite
.github/workflows/release.yml actions
  • actions/checkout v3 composite
.github/workflows/upload_pypi.yml actions
  • actions/checkout v3 composite
setup.py pypi
  • mcstasscript >=0.0.54
  • nexusformat >=0.7.8