jolideco
A Python package for Poisson joint likelihood deconvolution
Science Score: 77.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
Found 6 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
✓Committers with academic emails
1 of 2 committers (50.0%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.7%) to scientific vocabulary
Keywords
deconvolution
gamma-ray-astronomy
image-analysis
maximum-a-posteriori-estimation
pytorch
x-ray-astronomy
Last synced: 6 months ago
·
JSON representation
·
Repository
A Python package for Poisson joint likelihood deconvolution
Basic Info
Statistics
- Stars: 12
- Watchers: 5
- Forks: 4
- Open Issues: 10
- Releases: 2
Topics
deconvolution
gamma-ray-astronomy
image-analysis
maximum-a-posteriori-estimation
pytorch
x-ray-astronomy
Created almost 4 years ago
· Last pushed 10 months ago
Metadata Files
Readme
License
Code of conduct
Citation
README.rst
.. image:: http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat
:target: http://www.astropy.org
:alt: Powered by Astropy Badge
.. image:: https://readthedocs.org/projects/jolideco/badge/?version=latest
:alt: Documentation Status
:scale: 100%
:target: https://jolideco.readthedocs.io/en/latest/?badge=latest
.. image:: https://github.com/jolideco/jolideco/actions/workflows/ci_tests.yml/badge.svg?style=flat
:target: https://github.com/jolideco/jolideco/actions
:alt: GitHub actions CI
.. image:: https://zenodo.org/badge/493477451.svg
:target: https://zenodo.org/doi/10.5281/zenodo.10870554
:alt: DOI
Jolideco: a Python package for Poisson Joint Likelihood Deconvolution
---------------------------------------------------------------------
.. image:: https://raw.githubusercontent.com/jolideco/jolideco/main/docs/jolideco-illustration.png
:width: 600
:alt: Jolideco illustration
:align: center
Jolideco is a Python package for Joint Likelihood Deconvolution of astronomical images affected by
Poisson noise. It allows you to deblur and denoise images and do a joint image reconstruction of
multiple images from different instruments, while taking their specific instrument response functions,
such as point spread functions, exposure and instrument specific background emission into account.
To ensure a high fidelity of reconstructed features in the images, Jolideco relies on a patch based
image prior, which is based on a Gaussian Mixture Model (GMM).
Contributing Code, Documentation, or Feedback
---------------------------------------------
Jolideco is an open-source project and we welcome contributions of all kinds:
new features, bug fixes, documentation improvements, and more. If you are interested
in contributing, please get in contact with the maintainers and make sure to read the
`Code of Conduct `_.
Citation
--------
When using Jolideco, please cite the `version you used from Zenodo `_
and the following paper reference:
.. code-block:: bibtex
@article{Jolideco2024,
doi = {10.3847/1538-3881/ad6b98},
url = {https://dx.doi.org/10.3847/1538-3881/ad6b98},
year = {2024},
month = {sep},
publisher = {The American Astronomical Society},
volume = {168},
number = {4},
pages = {182},
author = {Axel Donath and Aneta Siemiginowska and Vinay L. Kashyap and David A. van Dyk and Douglas Burke},
title = {Joint Deconvolution of Astronomical Images in the Presence of Poisson Noise},
journal = {The Astronomical Journal},
}
Further Resources
------------------
Please also take a look at the following associated repositories:
- `Jolideco GMM Library `_
- `Jolideco Fermi-LAT Example `_
- `Jolideco Chandra Example `_
- `Webpage with Result Comparisons for Toy Datasets `_
Contributing
------------
While contributions are welcome in general, currently I cannot review PRs, nor help with implementations,
because of a lack of time. So PRs are unlikely to get merged. However any kind of bug report or feature
requests are welcome as well.
Owner
- Name: Jolideco
- Login: jolideco
- Kind: organization
- Repositories: 7
- Profile: https://github.com/jolideco
Jolideco is a software project for Joint Likelihood Deconvolution of Poisson data based on PyTorch
Citation (CITATION.cff)
# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!
cff-version: 1.2.0
title: "Jolideco: a Python library for Joint Likelihood deconvolution"
message: >-
If you use this software, please cite it using the
metadata from this file.
type: software
authors:
- given-names: Axel
family-names: Donath
email: axel.donath@cfa.harvard.edu
affiliation: Center for Astrophysics | Harvard & Smithsonian
orcid: 'https://orcid.org/0000-0003-4568-7005'
identifiers:
- type: doi
value: 10.5281/zenodo.10870554
repository-code: 'https://github.com/jolideco/jolideco'
url: 'https://jolideco.readthedocs.io/'
abstract: >-
Jolideco is a Python library for Joint Likelihood
deconvolution of a set of observations in the presence of
Poisson noise. It can be used to combine data from
multiple x-ray instruments such as Chandra, XMM-Newton or
gamma-ray instruments such as Fermi-LAT or H.E.S.S.. In
general Jolideco is designed to work with data from any
instrument affected by Poisson noise. It has a nice user
interface and is designed to be simple to use.
keywords:
- gamma-ray
- x-ray
- astronomy
- deblurring
- deconvolution
- denoising
- python
- PyTorch
license: BSD-3-Clause
version: v0.2
date-released: '2024-03-25'
GitHub Events
Total
- Issues event: 1
- Watch event: 9
- Issue comment event: 2
- Push event: 6
- Fork event: 2
- Create event: 1
Last Year
- Issues event: 1
- Watch event: 9
- Issue comment event: 2
- Push event: 6
- Fork event: 2
- Create event: 1
Committers
Last synced: 6 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Axel Donath | a****h@m****e | 470 |
| Aneta | a****e@g****m | 2 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 11
- Total pull requests: 4
- Average time to close issues: almost 2 years
- Average time to close pull requests: 1 day
- Total issue authors: 3
- Total pull request authors: 2
- Average comments per issue: 1.0
- Average comments per pull request: 0.0
- Merged pull requests: 4
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 1
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 1
- Pull request authors: 0
- Average comments per issue: 0.0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- adonath (9)
- pllim (1)
- anetasie (1)
Pull Request Authors
- adonath (3)
- anetasie (2)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 8 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 3
- Total maintainers: 1
pypi.org: jolideco
A Python package for Poisson joint likelihood deconvolution
- Documentation: https://jolideco.readthedocs.io/
- License: BSD 3-Clause
-
Latest release: 0.0.0
published almost 2 years ago
Rankings
Dependent packages count: 9.7%
Average: 36.7%
Dependent repos count: 63.7%
Maintainers (1)
Last synced:
6 months ago
Dependencies
.github/workflows/ci_cron_weekly.yml
actions
- actions/checkout v2 composite
- actions/setup-python v2 composite
.github/workflows/ci_tests.yml
actions
- actions/checkout v3 composite
- actions/setup-python v2 composite
environment.yaml
pypi
- ruamel.yaml.string *
pyproject.toml
pypi
- astropy >=5.2
- click *
- matplotlib *
- numpy >=1.26
- torch >1.13
- tqdm *
setup.py
pypi