ixpeobssim

Simulation and analysis framework for the Imaging X-ray Polarimetry Explorer

https://github.com/lucabaldini/ixpeobssim

Science Score: 46.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
    Links to: sciencedirect.com
  • Committers with academic emails
    1 of 6 committers (16.7%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.9%) to scientific vocabulary

Keywords

astronomy ixpe polarimetry python x-ray
Last synced: 6 months ago · JSON representation

Repository

Simulation and analysis framework for the Imaging X-ray Polarimetry Explorer

Basic Info
  • Host: GitHub
  • Owner: lucabaldini
  • License: gpl-3.0
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 78.8 MB
Statistics
  • Stars: 15
  • Watchers: 7
  • Forks: 16
  • Open Issues: 166
  • Releases: 0
Topics
astronomy ixpe polarimetry python x-ray
Created over 3 years ago · Last pushed 8 months ago
Metadata Files
Readme Contributing License Code of conduct Citation

README.md

ixpeobssim

Simulation and analysis framework for the Imaging X-ray Polarimetry Explorer

This is the public repository for the package described at SoftwareX, Volume 19, July 2022, 101194

Tag PyPI version PyPI - Downloads License: GPL v3 Documentation Status

GitHub repo size GitHub contributors GitHub last commit GitHub commit activity Libraries.io dependency status for GitHub repo

GitHub pull requests GitHub issues GitHub closed issues

Please refer to the documentation and, should you encounter any problem, feel free to use our issue tracker.

Synopsis

ixpeobssim is a simulation and analysis framework specifically developed for the Imaging X-ray Polarimetry Explorer (IXPE). Given a source model and the response functions of the telescopes, it is designed to produce realistic simulated observations, in the form of event lists in FITS format, containing a strict superset of the information included in the publicly released IXPE data products. The core simulation capabilities are complemented by a full suite of post-processing applications which support the spatial, spectral, and temporal models needed for analysis of typical polarized X-ray sources, allowing for the implementation of complex, polarization-aware analysis pipelines, and facilitating the interoperation with the standard visualization and analysis tools traditionally in use by the X-ray community.

Although much of the framework is specific to IXPE, the modular nature of the underlying implementation makes it potentially straightforward to adapt it to different missions with polarization capabilities.

Installation

In a nutshell, you should be able to install ixpeobssim via pip

pip install ixpeobssim

Refer to the installation instructions for more in-depth information.

Documentation

The ixpeobssim documentation is hosted on readthedocs, the most useful pointers being:

For convenience, a static version of the latest documentation in pdf format is available at this link.

Owner

  • Name: Luca Baldini
  • Login: lucabaldini
  • Kind: user
  • Location: Pisa (Italy)
  • Company: University and INFN Pisa

Why would anyone care?

GitHub Events

Total
  • Issues event: 3
  • Watch event: 4
  • Delete event: 1
  • Issue comment event: 9
  • Push event: 11
  • Pull request review event: 1
  • Pull request event: 1
  • Fork event: 1
  • Create event: 2
Last Year
  • Issues event: 3
  • Watch event: 4
  • Delete event: 1
  • Issue comment event: 9
  • Push event: 11
  • Pull request review event: 1
  • Pull request event: 1
  • Fork event: 1
  • Create event: 2

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 297
  • Total Committers: 6
  • Avg Commits per committer: 49.5
  • Development Distribution Score (DDS): 0.125
Top Committers
Name Email Commits
Luca Baldini l****i@p****t 260
alberto_manfreda a****m@p****t 14
simone_castellano s****o@g****m 13
ndilalla n****a@s****u 5
Stefano Silvestri s****n@g****m 3
Francesco Fenu f****u@g****m 2
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 87
  • Total pull requests: 57
  • Average time to close issues: 22 days
  • Average time to close pull requests: 3 days
  • Total issue authors: 19
  • Total pull request authors: 7
  • Average comments per issue: 2.74
  • Average comments per pull request: 0.32
  • Merged pull requests: 51
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 6
  • Pull requests: 3
  • Average time to close issues: 2 days
  • Average time to close pull requests: 2 days
  • Issue authors: 4
  • Pull request authors: 2
  • Average comments per issue: 2.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • lucabaldini (58)
  • albertomanfreda (7)
  • steveehlert (2)
  • s-silvestri (2)
  • yashbhargava1992 (2)
  • ndilalla (2)
  • ldigesu (1)
  • IndraniPal93 (1)
  • app46 (1)
  • simo7588 (1)
  • fabiolamonaca (1)
  • francescofenu (1)
  • sjgunderson (1)
  • joysankar0701 (1)
  • chenddnj (1)
Pull Request Authors
  • lucabaldini (40)
  • albertomanfreda (8)
  • s-silvestri (6)
  • simo7588 (5)
  • ndilalla (1)
  • alpv95 (1)
  • francescofenu (1)
Top Labels
Issue Labels
bug (4) enhancement (3) documentation (1) duplicate (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 57 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 29
  • Total maintainers: 2
pypi.org: ixpeobssim

Simulation and analysis framework for the Imaging X-ray Polarimetry Explorer

  • Versions: 29
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 57 Last month
Rankings
Dependent packages count: 6.6%
Downloads: 11.6%
Forks count: 13.6%
Average: 16.6%
Stargazers count: 20.5%
Dependent repos count: 30.6%
Maintainers (2)
Last synced: 6 months ago

Dependencies

requirements.txt pypi
  • astropy >=4.0
  • coverage *
  • matplotlib >=3.0
  • numpy >=1.17
  • pytest-cov *
  • regions >=0.4
  • scipy >=1.4
  • skyfield >=1.23
  • sphinxcontrib-programoutput *
.github/workflows/deploy.yaml actions
  • actions/checkout v2 composite
  • actions/setup-python v1 composite
  • actions/setup-python v2 composite
  • pypa/gh-action-pypi-publish v1.1.0 composite
.github/workflows/setup_and_test.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite