Skip to content

genulens v2.0.0-alpha.1

Latest
Latest

Choose a tag to compare

View all tags
@NunotaKansuke NunotaKansuke released this 25 Jun 17:12
v2.0.0-alpha.1
5d52e90
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

This is the first alpha release of the refactored genulens v2 codebase.
This release is intended for testing and early feedback before a stable v2 release.

Highlights

  • Modularized the genulens C++ core into reusable model and simulation components.
  • Kept the historical command-line interface available.
  • Added direct Python bindings via pybind11.
  • Added Python custom likelihood support.
  • Added source-forward isochrone mode for source stellar properties.
  • Added genstars-style extinction laws and extinction-map support.
  • Added optical-depth and event-rate summary/map APIs.
  • Added updated documentation and public notebook examples.

Python API

The Python API now calls the C++ simulation core directly. It does not run ./genulens as a subprocess and does not parse CLI stdout.

New workflows include:

  • plain event simulation from Python
  • custom likelihood functions
  • source-forward source-property annotations
  • isochrone-systematics experiments
  • optical-depth and event-rate maps

Source-forward mode

The new isochrone source mode can attach source properties such as:

  • M_S_ini
  • M_S
  • R_S
  • teff_S
  • logg_S
  • theta_S
  • absolute magnitudes such as M_Imag_S, M_Hmag_2mass_S, and M_F146mag_S

Validation

Validated locally after merging to main:

  • cmake --build build -j 4
  • ./build/test_core
  • bash tests/smoke/smoke_cli.sh
  • PYTHONPATH=build pytest -q tests/smoke/test_python.py tests/smoke/test_genulens_source_compat.py

Result:

  • Python smoke: 38 passed, 3 skipped

The classic I-band rate path has also been checked against the legacy genulens_source summary calculation.

Known caveats

This is an alpha release.

  • H-band/source-forward event rates are model-dependent forward predictions, not legacy-compatible rates.
  • Isochrone outputs depend on PARSEC/MIST choice, IMF, age/metallicity prior, abundance assumptions, passbands, and extinction model.
  • PARSEC alpha-enhanced tables are not treated as available; alpha-enhancement systematics are handled through MIST where available.
  • Non-standard GSL installs require GSL_ROOT at build time and LD_LIBRARY_PATH at runtime.
  • pre_gapmoe remains a command-line helper set for gapmoe; it is not yet exposed as a direct Python ndarray API.

Documentation

Start from:

  • docs/README.md
  • docs/quickstart.md
  • docs/python_api.md
  • docs/source_forward.md
  • docs/extinction.md
  • docs/rate_maps.md
  • docs/isochrone_systematics.md
  • docs/pre_gapmoe.md
Assets 2
Loading