prospecpy
An open-source package for processing, visualizing, and analyzing FTIR Spectroscopy data.
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
Links to: zenodo.org -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.6%) to scientific vocabulary
Repository
An open-source package for processing, visualizing, and analyzing FTIR Spectroscopy data.
Basic Info
- Host: GitHub
- Owner: ProSpecPy
- License: bsd-3-clause
- Language: Python
- Default Branch: main
- Size: 162 KB
Statistics
- Stars: 1
- Watchers: 3
- Forks: 4
- Open Issues: 3
- Releases: 1
Metadata Files
README.md
ProSpecPy
Overview
ProSpecPy is a fully modular Python package developed to process FTIR spectroscopy data from Bruker instruments. Created in collaboration between SSEC and Dr. Elizabeth Phillips of The Grantham Institute at Imperial College London (formerly Vincent Research Group at Oxford University), this tool streamlines data analysis workflows and significantly reduces sample processing time.
The package is designed to be user-friendly and flexible, allowing researchers to customize their data analysis workflows according to their specific needs. ProSpecPy is built on the principles of modularity, interactivity, and automation, making it a powerful tool for FTIR data processing.
ProSpecPy is designed to be used in conjunction with Jupyter Notebooks, providing an interactive environment for data analysis. The package also supports batch processing, allowing users to apply common operations across multiple samples efficiently.
Software Solution
ProSpecPy provides a comprehensive solution for FTIR data processing, addressing the limitations of existing software tools. It is designed to be user-friendly and flexible, allowing researchers to customize their data analysis workflows according to their specific needs. The package is built on the following key elements:
- A modular Python package for efficient FTIR data processing
- Jupyter Notebook integration for interactive data analysis
- Automated batch processing for common operations across samples
- User-customizable preferences for individual sample processing
- GitHub Codespaces integration for streamlined development
Installation and Usage
For the easiest way to get started with ProSpecPy, we recommend using GitHub Codespaces. This allows you to run the package in a cloud-based environment without needing to install anything locally.
Click the button below 👇
After the codespace is loaded up, begin by creating two folders within the main directory: data and notebooks. Once you have created the notebooks folder, make a copy of the workflow demo notebook from the doc folder and move it over. Once you have done so, change the name to reflect the name of your run or experiment.
Contributing
ProSpecPy is currently under development after an initial release. If you are interested in contributing, please check out our open issues and fork the repository to begin making changes within our object-oriented architecture.
License
This project is licensed under the BSD 3-Clause License - see the LICENSE file for details.
Owner
- Name: ProSpecPy
- Login: ProSpecPy
- Kind: organization
- Repositories: 1
- Profile: https://github.com/ProSpecPy
Citation (CITATION.cff)
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Tambay"
given-names: "Anshul"
orcid: "https://orcid.org/0009-0004-9010-1223"
- family-names: "Phillips"
given-names: "Elizabeth"
orcid: "https://orcid.org/0000-0002-3412-5480"
- family-names: "Ramachandran"
given-names: "Anuradha"
- family-names: "Xue"
given-names: "Eric"
orcid: "https://orcid.org/0009-0009-9233-6081"
- family-names: "Somah"
given-names: "Annatu Ammadu"
orcid: "https://orcid.org/0009-0001-3484-4944"
title: "ProSpecPy: FTIR Spectroscopy Data Processing Library"
url: "https://prospecpy.readthedocs.io"
repository-code: "https://github.com/ProSpecPy/ProSpecPy"
GitHub Events
Total
- Issues event: 1
- Delete event: 3
- Issue comment event: 2
- Member event: 2
- Push event: 40
- Pull request event: 8
- Fork event: 2
- Create event: 4
Last Year
- Issues event: 1
- Delete event: 3
- Issue comment event: 2
- Member event: 2
- Push event: 40
- Pull request event: 8
- Fork event: 2
- Create event: 4
Dependencies
- actions/checkout v4 composite
- actions/download-artifact v4 composite
- hynek/build-and-inspect-python-package v2 composite
- pypa/gh-action-pypi-publish release/v1 composite
- actions/checkout v4 composite
- actions/setup-python v5 composite
- codecov/codecov-action v4.5.0 composite
- pre-commit/action v3.0.1 composite
- jupyter-book *
- matplotlib *
- numpy *
- pandas *
- requests *