POSYDON-code / POSYDON-code/POSYDON

Add a worked tutorial for the XRB luminosity utilities

Open
#886 0 comments 0 reactions 1 assignee View on GitHub

@tassos25 is already working on this.

Since Aug 14, 2026.

documentation
Dominant language
Python
Stars
45
Forks
37
Avg merge
8d 20h
Merged PRs (30d)
5

Description

Context

PR #881 adds small property-based XRB utility functions with complete API docstrings and literature references. The API reference can therefore be generated automatically, but it does not replace a worked scientific tutorial.

Proposed tutorial

Add a population-synthesis tutorial that demonstrates:

  • selecting bound BH/NS systems with non-compact donors;
  • mapping POSYDON S1/S2 columns to donor and accretor properties;
  • distinguishing RLO, wind-fed, and Be-XRB systems;
  • calculating BH/NS efficiencies, Eddington quantities, wind capture, classical luminosities, and King beaming;
  • applying observational band corrections outside the utility module;
  • constructing a weighted cumulative XLF; and
  • documenting assumptions and deferred physics such as GRRMHD, magnetic NS accretion, and wind-disc formation.

The tutorial should be executable with a documented POSYDON version and a small registered example dataset. It should be reviewed separately from #881.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.