islatu

islatu: A Python package for the reduction of reflectometry data - Published in JOSS (2022)

https://github.com/DiamondLightSource/islatu

Science Score: 36.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
    5 of 6 committers (83.3%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.2%) to scientific vocabulary

Scientific Fields

Mathematics Computer Science - 84% confidence
Last synced: 10 months ago · JSON representation

Repository

X-ray reflectometry reduction from Diamond Light Source

Basic Info
Statistics
  • Stars: 1
  • Watchers: 3
  • Forks: 2
  • Open Issues: 2
  • Releases: 5
Created over 6 years ago · Last pushed 11 months ago
Metadata Files
Readme License

README.md

islatu

X-ray reflectometry reduction from Diamond Light Source

codecov Actions Status Documentation Status

Install

This package can be easily installed using pip install islatu.

Installation from source

To install in a fresh environment, first ensure that pip is available. For example, using conda:

conda create --name islatu conda activate islatu conda install pip

Assuming that pip is available, installation of the library from source can be done by cloning this repository. Navigate to its directory and use pip to install this package and its dependencies as follows:

python -m pip install . -r requirements.txt

Make sure that your installation is functioning by running pytest.

Documentation

The documentation for this package can be found at https://islatu.readthedocs.io/en/latest/

An example of a typical data reduction workflow can be found at https://islatu.readthedocs.io/en/latest/i07_reflectivity.html

To build the documentation, make sure you have sphinx installed on your system. Go to the docs directory and run

make html

Owner

  • Name: Diamond Light Source
  • Login: DiamondLightSource
  • Kind: organization

GitHub Events

Total
  • Delete event: 16
  • Issue comment event: 12
  • Push event: 87
  • Pull request event: 39
  • Create event: 18
Last Year
  • Delete event: 16
  • Issue comment event: 12
  • Push event: 87
  • Pull request event: 39
  • Create event: 18

Committers

Last synced: 11 months ago

All Time
  • Total Commits: 356
  • Total Committers: 6
  • Avg Commits per committer: 59.333
  • Development Distribution Score (DDS): 0.48
Past Year
  • Commits: 90
  • Committers: 2
  • Avg Commits per committer: 45.0
  • Development Distribution Score (DDS): 0.311
Top Committers
Name Email Commits
Brearton, Richard (DLSLtd,RAL,LSCI) r****n@d****k 185
Philip Mousley p****y@h****m 63
Andrew McCluskey a****y@d****k 52
Philip Mousley p****y@d****k 28
Philip Mousley p****y@d****k 26
Andrew McCluskey a****y@b****k 2
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 5
  • Total pull requests: 45
  • Average time to close issues: 30 days
  • Average time to close pull requests: 4 minutes
  • Total issue authors: 3
  • Total pull request authors: 4
  • Average comments per issue: 1.0
  • Average comments per pull request: 0.58
  • Merged pull requests: 42
  • Bot issues: 0
  • Bot pull requests: 1
Past Year
  • Issues: 0
  • Pull requests: 42
  • Average time to close issues: N/A
  • Average time to close pull requests: 4 minutes
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.62
  • Merged pull requests: 40
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • daguiam (2)
  • andyfaff (2)
  • chelberserker (1)
Pull Request Authors
  • P-Mousley (42)
  • lgtm-com[bot] (1)
  • arm61 (1)
  • RBrearton (1)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

requirements.txt pypi
  • coverage ==6.3.2
  • coverage *
  • ipywidgets *
  • jupyter-sphinx *
  • jupyterlab *
  • nbsphinx *
  • nexusformat *
  • numpy *
  • pandas *
  • pytest *
  • pytest-cov *
  • pytest-lazy-fixture *
  • pyyaml *
  • scipy *
  • wheel *
.github/workflows/coverage.yml actions
  • actions/checkout v2 composite
  • actions/setup-python master composite
  • codecov/codecov-action v2 composite
.github/workflows/pytest.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
.github/workflows/python-publish.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • pypa/gh-action-pypi-publish 27b31702a0e7fc50959f5ad993c78deac1bdfc29 composite
setup.py pypi
docs/source/requirements.txt pypi
  • ipykernel *
  • jupyter_sphinx *
  • nbsphinx *
  • sphinx-collapse *
pyproject.toml pypi