spectrapepper

spectrapepper: A Python toolbox for advanced analysis of spectroscopic data for materials and devices. - Published in JOSS (2021)

https://github.com/spectrapepper/spectrapepper

Science Score: 95.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 6 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: joss.theoj.org
  • Committers with academic emails
    1 of 10 committers (10.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Scientific Fields

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

Repository

A Python package for advanced processing and combinatorial analysis of spectroscopy data.

Basic Info
  • Host: GitHub
  • Owner: spectrapepper
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 9.04 MB
Statistics
  • Stars: 16
  • Watchers: 3
  • Forks: 5
  • Open Issues: 1
  • Releases: 21
Created almost 5 years ago · Last pushed over 1 year ago
Metadata Files
Readme Contributing License Zenodo

README.md

image Anaconda-Server Badge image CodeQL image codecov Downloads image image DOI

A Python package to simplify and accelerate analysis of spectroscopy data.

  • GitHub repo: https://github.com/spectrapepper/spectrapepper
  • Documentation: https://spectrapepper.github.io/spectrapepper
  • PyPI: https://pypi.python.org/pypi/spectrapepper
  • Conda-forge: https://anaconda.org/conda-forge/spectrapepper
  • Free software: MIT license

Introduction

spectrapepper is a Python package that makes advanced analysis of spectroscopic data easy and accessible through straightforward, simple, and intuitive code. This library contains functions for every stage of spectroscopic methodologies, including data acquisition, pre-processing, processing, and analysis. In particular, advanced and high statistic methods are intended to facilitate, namely combinatorial analysis and machine learning, allowing also fast and automated traditional methods.

Features

The following is a short list of some main procedures that spectrapepper package enables.

  • Baseline removal functions.
  • Normalization methods.
  • Noise filters, trimming tools, and despiking methods.
  • Chemometric algorithms to find peaks, fit curves, and deconvolution of spectra.
  • Combinatorial analysis tools, such as Spearman, Pearson, and n-dimensional correlation coefficients.
  • Tools for Machine Learning applications, such as data merging, randomization, and decision boundaries.
  • Sample data and examples.

Quickstart

  1. Install this library using pip:

    pip install spectrapepper
    
  2. Install this library using conda-forge:

    conda install -c conda-forge spectrapepper
    
  3. Test it by plotting some data:

    import spectrapepper as spep
    import matplotlib.pyplot as plt
    
    x, y = spep.load_spectras()
    for i in y:
        plt.plot(x, i)
    plt.xlabel('Raman shift ($cm^{-1}$)')
    plt.ylabel('Intensity (a.u.)')
    plt.show()
    
  4. If you find this library useful, please consider a reference or citation as:

    Grau-Luque et al., (2021). spectrapepper: A Python toolbox for advanced analysis
    of spectroscopic data for materials and devices. Journal of Open Source Software,
    6(67), 3781, https://doi.org/10.21105/joss.03781
    
  5. Stay up-to-date by updating the library using:

    conda update spectrapepper pip install --update spectrapepper

  6. If you encounter problems when updating, try uninstalling and then re-installing::

    pip uninstall spectrapepper
    conda remove spectrapepper
    

Credits

This package was created with Cookiecutter and the giswqs/pypackage project template.

JOSS Publication

spectrapepper: A Python toolbox for advanced analysis of spectroscopic data for materials and devices.
Published
November 19, 2021
Volume 6, Issue 67, Page 3781
Authors
Enric Grau-Luque ORCID
Catalonia Institute for Energy Research (IREC), Jardins de les Dones de Negre 1, 08930 Sant Adrià de Besòs, Spain
Fabien Atlan ORCID
Catalonia Institute for Energy Research (IREC), Jardins de les Dones de Negre 1, 08930 Sant Adrià de Besòs, Spain
Ignacio Becerril-Romero ORCID
Catalonia Institute for Energy Research (IREC), Jardins de les Dones de Negre 1, 08930 Sant Adrià de Besòs, Spain
Alejandro Perez-Rodriguez ORCID
Catalonia Institute for Energy Research (IREC), Jardins de les Dones de Negre 1, 08930 Sant Adrià de Besòs, Spain, Departament d'Enginyeria Electrònica i Biomèdica, IN2UB, Universitat de Barcelona, C/ Martí i Franqués 1, 08028 Barcelona, Spain
Maxim Guc ORCID
Catalonia Institute for Energy Research (IREC), Jardins de les Dones de Negre 1, 08930 Sant Adrià de Besòs, Spain
Victor Izquierdo-Roca ORCID
Catalonia Institute for Energy Research (IREC), Jardins de les Dones de Negre 1, 08930 Sant Adrià de Besòs, Spain
Editor
Rachel Kurchin ORCID
Tags
Spectroscopy Energy materials Combinatorial analysis Machine learning

GitHub Events

Total
Last Year

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 207
  • Total Committers: 10
  • Avg Commits per committer: 20.7
  • Development Distribution Score (DDS): 0.415
Past Year
  • Commits: 3
  • Committers: 1
  • Avg Commits per committer: 3.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Enric Tomas Grau Luque e****u@i****t 121
enricgrau p****c@g****m 59
jongari7 j****i@i****t 13
tristanmech t****h 7
Enric Grau e****c@l****m 2
github-actions[bot] g****] 1
Stuart Campbell s****t@s****e 1
Rachel Kurchin r****n@c****u 1
Kyle Sunden g****t@k****e 1
unknown i****l@I****l 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 5
  • Total pull requests: 19
  • Average time to close issues: 13 days
  • Average time to close pull requests: 2 months
  • Total issue authors: 3
  • Total pull request authors: 6
  • Average comments per issue: 1.4
  • Average comments per pull request: 0.84
  • Merged pull requests: 15
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 3
  • Average time to close issues: N/A
  • Average time to close pull requests: 2 days
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • ksunden (3)
  • stuartcampbell (1)
  • enricgrau (1)
Pull Request Authors
  • jongari7 (20)
  • enricgrau (8)
  • stuartcampbell (1)
  • tristanmech (1)
  • ksunden (1)
  • rkurchin (1)
Top Labels
Issue Labels
bug (1)
Pull Request Labels

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 50 last-month
  • Total dependent packages: 1
    (may contain duplicates)
  • Total dependent repositories: 1
    (may contain duplicates)
  • Total versions: 21
  • Total maintainers: 1
pypi.org: spectrapepper

A Python package to simplify and accelerate analysis of spectroscopy data

  • Versions: 12
  • Dependent Packages: 1
  • Dependent Repositories: 1
  • Downloads: 50 Last month
Rankings
Dependent packages count: 4.8%
Downloads: 12.1%
Average: 14.4%
Stargazers count: 16.6%
Forks count: 16.9%
Dependent repos count: 21.5%
Maintainers (1)
Last synced: 6 months ago
conda-forge.org: spectrapepper
  • Versions: 9
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 34.0%
Average: 46.9%
Stargazers count: 50.9%
Dependent packages count: 51.2%
Forks count: 51.6%
Last synced: 6 months ago

Dependencies

.github/workflows/build.yml actions
  • actions/checkout v3.1.0 composite
  • actions/setup-python v4.3.0 composite
.github/workflows/codecov.yml actions
  • actions/checkout v3.1.0 composite
  • actions/setup-python v4.3.0 composite
  • codecov/codecov-action v3.1.1 composite
.github/workflows/codeql.yml actions
  • actions/checkout v3 composite
  • github/codeql-action/analyze v2 composite
  • github/codeql-action/autobuild v2 composite
  • github/codeql-action/init v2 composite
.github/workflows/docs.yml actions
  • actions/checkout v3.1.0 composite
  • actions/setup-python v4.3.0 composite
.github/workflows/pypi.yml actions
  • actions/checkout v3.1.0 composite
  • actions/setup-python v4.3.0 composite
.github/workflows/updater.yml actions
  • actions/checkout v3.1.0 composite
  • saadmk11/github-actions-version-updater v0.7.1 composite
requirements.txt pypi
  • matplotlib *
  • numpy >=1.20
  • pandas *
  • scipy *
requirements_dev.txt pypi
  • Sphinx * development
  • bump2version * development
  • coverage * development
  • flake8 * development
  • grip * development
  • livereload * development
  • pip * development
  • tox * development
  • twine * development
  • watchdog * development
  • wheel * development
setup.py pypi
  • x.strip *
pyproject.toml pypi