Science Score: 49.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: arxiv.org -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.5%) to scientific vocabulary
Repository
Basic Info
- Host: GitHub
- Owner: QUEL-Imaging
- License: agpl-3.0
- Language: Python
- Default Branch: main
- Size: 33.8 MB
Statistics
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 2
- Releases: 6
Metadata Files
README.md
QUEL-QAL: QUEL Quantitative Analysis Library
Welcome to quel-qal! This repository contains Python code for analyzing images of QUEL Imaging's fluorescence phantoms and obtaining relevant metrics about the capabilities of your fluorescence imaging system. Find more information about our fluorescence targets on our website. Documentation on how to use quel-qal to analyze images can be found in the doc folder and in the Wiki.
Getting Started
This guide will help you get started with setting up and using quel-qal. Follow the steps below to install directly from PyPI, or clone this repository locally. Conda installation is not currently supported.
Prerequisites
- Quel-qal requires Python version 3.12.
- It is also recommended (though not required) to set up a separate virtual environment to install to. On your terminal, navigate to the directory where you would like to install the virtual environment. Create and activate a new virtual environment as follows.
On macOS/Linux:
python3 -m venv env
source env/bin/activate
On Windows:
python -m venv env
env\Scripts\activate
If you will be working in an iPython environment (Jupyter notebook, JupyterLab), create and activate a virtual environment as described above, then do the following to install your virtual environment as a kernel for Jupyter (change python to python3 in the last line accordingly):
pip install jupyter
pip install ipykernel
python -m ipykernel install --user --name=env --display-name="quel-qal_env"
When you launch Jupyter you will see "quel-qal_env" as an option in the available kernels.
PyPI Installation
You can install quel-qal directly from PyPI using:
pip install quel-qal
This will install quel-qal along with all its dependencies.
GitHub Installation
Alternatively, you can install the repository from GitHub by following these steps:
1. Clone the repository:
git clone https://github.com/QUEL-Imaging/quel-qal.git
cd quel-qal
2. Set up a virtual environment (optional):
Create and activate a virtual environment as described above.
3. Install dependencies:
You can install the required dependencies using pip:
pip install -r requirements.txt
4. Install quel-qal:
pip install -e .
License
Source Code
The source code in this repository is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0).
Documentation
The contents of the doc folder in this repository are licensed under the Creative Commons Attribution 4.0 International (CC BY 4.0).
Notes
- If you contribute to this repository, you agree that your contributions to the source code will be licensed under AGPL-3.0 and your contributions to the documentation will be licensed under CC BY 4.0.
- Please ensure compliance with both licenses when using or modifying the content of this repository.
Citation
If you use QUEL-QAL in your research, please cite our paper:
Eammon A. Littler, Emmanuel A. Mannoh, Ethan P. M. LaRochelle. Fluorescence Reference Target Quantitative Analysis Library. arXiv:2504.15496 [physics.med-ph], 2025. https://arxiv.org/abs/2504.15496
BibTeX:
bibtex
@article{quel-qal,
author = {Eammon A. Littler and Emmanuel A. Mannoh and Ethan P. M. LaRochelle},
title = {{Fluorescence Reference Target Quantitative Analysis Library}},
journal = {arXiv preprint arXiv:2504.15496},
year = {2025},
url = {https://arxiv.org/abs/2504.15496},
eprint = {2504.15496},
archivePrefix = {arXiv},
primaryClass = {physics.med-ph}
}
Funding
This work is partially funded by the NIH and ARPA-H: - NIBIB Grants R43/44 EB029804 - NCI Contract 75N91021C00035 - NCI/ARPA-H Contract 75N91023C00052
Owner
- Name: QUEL Imaging, LLC
- Login: QUEL-Imaging
- Kind: organization
- Location: White River Junction, VT
- Website: https://www.quelimaging.com
- Repositories: 1
- Profile: https://github.com/QUEL-Imaging
GitHub Events
Total
- Create event: 18
- Issues event: 9
- Release event: 6
- Watch event: 1
- Delete event: 8
- Member event: 1
- Issue comment event: 8
- Push event: 47
- Pull request review event: 25
- Pull request review comment event: 3
- Pull request event: 40
- Gollum event: 25
Last Year
- Create event: 18
- Issues event: 9
- Release event: 6
- Watch event: 1
- Delete event: 8
- Member event: 1
- Issue comment event: 8
- Push event: 47
- Pull request review event: 25
- Pull request review comment event: 3
- Pull request event: 40
- Gollum event: 25
Issues and Pull Requests
Last synced: 7 months ago
All Time
- Total issues: 6
- Total pull requests: 19
- Average time to close issues: 18 days
- Average time to close pull requests: 6 days
- Total issue authors: 1
- Total pull request authors: 3
- Average comments per issue: 0.33
- Average comments per pull request: 0.37
- Merged pull requests: 16
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 6
- Pull requests: 19
- Average time to close issues: 18 days
- Average time to close pull requests: 6 days
- Issue authors: 1
- Pull request authors: 3
- Average comments per issue: 0.33
- Average comments per pull request: 0.37
- Merged pull requests: 16
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- emannoh (6)
Pull Request Authors
- emannoh (13)
- ealitt (3)
- ethan-quel-i (2)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 31 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 5
- Total maintainers: 2
pypi.org: quel-qal
A Python library for analyzing Quel Imaging fluorescent phantoms and imaging targets.
- Documentation: https://quel-qal.readthedocs.io/
- License: AGPL-3.0
-
Latest release: 0.2.5
published 12 months ago