marxs

Multi-Architecture-Raytrace-Xraymission-Simulator

https://github.com/chandra-marx/marxs

Science Score: 85.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 3 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    2 of 8 committers (25.0%) from academic institutions
  • Institutional organization owner
    Organization chandra-marx has institutional domain (space.mit.edu)
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.5%) to scientific vocabulary

Keywords

astronomy python raytracing

Keywords from Contributors

astropy astropy-affiliated photometry source-detection ccd
Last synced: 6 months ago · JSON representation ·

Repository

Multi-Architecture-Raytrace-Xraymission-Simulator

Basic Info
Statistics
  • Stars: 7
  • Watchers: 2
  • Forks: 9
  • Open Issues: 25
  • Releases: 4
Topics
astronomy python raytracing
Created almost 11 years ago · Last pushed over 1 year ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Support Zenodo

README.md

MARXS

Multi-Architecture-Raytrace-Xraymission-Simulator

PyPI - Version

DOI

CI tests

Documentation Status

Coverage Status

Powered by Astropy

What does MARXS do?

MARXS (Multi-Architecture-Raytrace-Xraymission-Simulator) is a toolsuite to simulate X-ray observatories. It is primarily aimed at astronomical X-ray satellites and sounding rocket payloads, but can be used to ray-trace experiments in the laboratory as well. MARXS performs polarization Monte-Carlo ray-trace simulations from a source (astronomical or lab) through a collection of optical elements such as mirrors, baffles, and gratings to a detector.

MARXS modular structure is designed to serve two main use cases:

  • Build-your-own instrument: Instrument designers can construct any X-ray experiment from a set of building blocks such as mirrors, diffraction gratings and CCD detectors.
  • Simulate science observations: Given an instrument configuration, simulate the detector output for any set of X-ray sources in the lab or on the sky.

Installation

See the installation instructions in the documentation.

Citation

Look at the CITATION file for the citation information.

Contributions

We welcome contributions through pull requests on Github. Please follow our code of conduct.

Owner

  • Name: Chandra-MARX
  • Login: Chandra-MARX
  • Kind: organization

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Günther"
  given-names: "Hans Moritz"
  orcid: "https://orcid.org/0000-0003-4243-2840"
- family-names: "Frost"
  given-names: "Jason"
- family-names: "Theriault-Shay"
  given-names: "Adam"
title: "MARXS"
version: 2.0
doi: 10.5281/zenodo.11104969
date-released: 2024-05-02
url: "https://github.com/github-linguist/linguist"
preferred-citation:
  type: article
  authors:
  - family-names: "Günther"
    given-names: "Hans Moritz"
    orcid: "https://orcid.org/0000-0003-4243-2840"
  - family-names: "Frost"
    given-names: "Jason"
  - family-names: "Theriault-Shay"
    given-names: "Adam"
  doi: "10.3847/1538-3881/aa943b"
  journal: "Journal Title"
  month: 12
  eid: 243
  pages: 243 
  title: "MARXS: A Modular Software to Ray-trace X-Ray Instrumentation "
  issue: 6
  volume: 154
  year: 2017

GitHub Events

Total
  • Issues event: 2
  • Watch event: 1
  • Issue comment event: 1
Last Year
  • Issues event: 2
  • Watch event: 1
  • Issue comment event: 1

Committers

Last synced: about 2 years ago

All Time
  • Total Commits: 717
  • Total Committers: 8
  • Avg Commits per committer: 89.625
  • Development Distribution Score (DDS): 0.07
Past Year
  • Commits: 74
  • Committers: 1
  • Avg Commits per committer: 74.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Hans Moritz Günther h****r@m****u 667
Jason Frost J****n@J****l 20
Brigitta Sipocz b****z@g****m 15
Adam Theriault-Shay a****y@d****u 9
Brigitta Sipocz b****z@g****m 3
astrobot t****m@c****g 1
Thomas Robitaille t****e@g****m 1
dependabot-preview[bot] 2****] 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 32
  • Total pull requests: 74
  • Average time to close issues: over 1 year
  • Average time to close pull requests: 7 days
  • Total issue authors: 4
  • Total pull request authors: 4
  • Average comments per issue: 0.81
  • Average comments per pull request: 0.14
  • Merged pull requests: 72
  • Bot issues: 0
  • Bot pull requests: 1
Past Year
  • Issues: 2
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 2
  • 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
  • hamogu (28)
  • pllim (2)
  • kelle (1)
  • astrofrog (1)
Pull Request Authors
  • hamogu (78)
  • bsipocz (6)
  • astrobot (1)
  • dependabot-preview[bot] (1)
Top Labels
Issue Labels
doc (3) enhancement (2) low priority (1)
Pull Request Labels
dependencies (1)

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 2
conda-forge.org: marxs

MARXS (Multi-Architecture-Raytrace-Xraymission-Simulator) is a toolsuite to simulate the performance X-ray observatories. It is primarily aimed at astronomical X-ray satellites and sounding rocket payloads, but can be used to ray-trace experiments in the laboratory as well. MARXS performs Monte-Carlo ray-trace simulations from a source (astronomical or lab) through a collection of optical elements such as mirrors, baffles, and gratings to a detector.

  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 34.0%
Forks count: 44.7%
Average: 46.4%
Dependent packages count: 51.2%
Stargazers count: 55.7%
Last synced: 6 months ago

Dependencies

.github/workflows/ci_tests.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
pyproject.toml pypi
setup.py pypi