Skip to main content

No project description provided

Project description

rail_bpz

codecov PyPI

RAIL interface to BPZ algorithms via the DESC_BPZ package implementation (also available via PyPI with pip install desc-bpz). Anyone using BPZ via either rail_bpz or DESC_BPZ should cite both Benitez (2000) and Coe et al. (2006).

In addition to the "default" BPZ CWWSB SED template set, rail_base now also includes an additional set of 31 template SEDs, a set that was used to compute the COSMOS 30-band photo-z's using LePhare. The template set consists of empirical templates from Poletta et al 2007 supplemented with blue BC03 SEDs, see Ilbert et al 2009 and Dahlen et al 2013 for details. The demo notebook BPZ_lite_demo.ipynb in the rail examples repository shows an example of how to use this alternate template set.

As the "lite" name implies, not all features of BPZ are implemented, the main product is the marginalized redshift PDF, which is output for a sample as a qp ensemble. However, several other quantities are computed and stored as "ancillary" data and stored with the ensemble, these are:

  • zmode (float): the mode of the marginalized posterior redshift PDF distribution.
  • zmean (float): the mean of the marginalized posterior redshift PDF distribution.
  • tb (int): the integer index for the "best-fit" SED template at the redshift mode, zmode. Note that the best-fit template can be different at different redshifts as the SED observed colors change with redshift, so you can not assume this single SED for the full marginalized PDF, it should only be used for the "point estimate" redshift zmode.
  • todds (float): relating to the comment above on tb, todds is a new quantity not included with the original BPZ implementation, it is the fraction of marginalized posterior probability assigned to tb. So, high values of todds would mean that no other templates fit well, even at other redshifts, while a lower value of todds means that there are alternative fits, either at the same redshift or other redshifts. If you are wanting to compute physical quantities based on tb, a lower value of todds would mean that such fits would be missing degenerate SED solutions, and should not be trusted.

Contributing

The greatest strength of RAIL is its extensibility; those interested in contributing to RAIL should start by consulting the Contributing guidelines on ReadTheDocs.

Citing RAIL

RAIL is open source and may be used according to the terms of its LICENSE (BSD 3-Clause). If you used RAIL in your study, please cite this repository https://github.com/LSSTDESC/RAIL, and RAIL Team et al. (2025) https://arxiv.org/abs/2505.02928

@ARTICLE{2025arXiv250502928T,
       author = {{The RAIL Team} and {van den Busch}, Jan Luca and {Charles}, Eric and {Cohen-Tanugi}, Johann and {Crafford}, Alice and {Crenshaw}, John Franklin and {Dagoret}, Sylvie and {De-Santiago}, Josue and {De Vicente}, Juan and {Hang}, Qianjun and {Joachimi}, Benjamin and {Joudaki}, Shahab and {Bryce Kalmbach}, J. and {Kannawadi}, Arun and {Liang}, Shuang and {Lynn}, Olivia and {Malz}, Alex I. and {Mandelbaum}, Rachel and {Merz}, Grant and {Moskowitz}, Irene and {Oldag}, Drew and {Ruiz-Zapatero}, Jaime and {Rahman}, Mubdi and {Rau}, Markus M. and {Schmidt}, Samuel J. and {Scora}, Jennifer and {Shirley}, Raphael and {St{\"o}lzner}, Benjamin and {Toribio San Cipriano}, Laura and {Tortorelli}, Luca and {Yan}, Ziang and {Zhang}, Tianqing and {the Dark Energy Science Collaboration}},
        title = "{Redshift Assessment Infrastructure Layers (RAIL): Rubin-era photometric redshift stress-testing and at-scale production}",
      journal = {arXiv e-prints},
     keywords = {Instrumentation and Methods for Astrophysics, Cosmology and Nongalactic Astrophysics, Astrophysics of Galaxies},
         year = 2025,
        month = may,
          eid = {arXiv:2505.02928},
        pages = {arXiv:2505.02928},
          doi = {10.48550/arXiv.2505.02928},
archivePrefix = {arXiv},
       eprint = {2505.02928},
 primaryClass = {astro-ph.IM},
       adsurl = {https://ui.adsabs.harvard.edu/abs/2025arXiv250502928T},
      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}

Please consider also inviting the developers as co-authors on publications resulting from your use of RAIL by making an issue.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pz_rail_bpz-2.1.0.tar.gz (27.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pz_rail_bpz-2.1.0-py3-none-any.whl (20.9 kB view details)

Uploaded Python 3

File details

Details for the file pz_rail_bpz-2.1.0.tar.gz.

File metadata

  • Download URL: pz_rail_bpz-2.1.0.tar.gz
  • Upload date:
  • Size: 27.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pz_rail_bpz-2.1.0.tar.gz
Algorithm Hash digest
SHA256 4c98540371cdd8c69b6d3c33f54618625d22360951b4a50f30784141354c1ce0
MD5 b68eaee6a9fc80792def9ff8a3e5da17
BLAKE2b-256 7dc55616f4fcc5244d6efd8ed38c9b4ebde41640ed94b393c745ccb2f79d60f7

See more details on using hashes here.

Provenance

The following attestation bundles were made for pz_rail_bpz-2.1.0.tar.gz:

Publisher: publish-to-pypi.yml on LSSTDESC/rail_bpz

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pz_rail_bpz-2.1.0-py3-none-any.whl.

File metadata

  • Download URL: pz_rail_bpz-2.1.0-py3-none-any.whl
  • Upload date:
  • Size: 20.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pz_rail_bpz-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6260b429686597c215924c53dfe5703a495522bad1cddc4f2c0ccdc0197ad70b
MD5 f0c8c595abdcc34efc29c97cc964518a
BLAKE2b-256 e9b5d759ef4ca6ae7df696ea6f106013339675f29671096705f9a5b671ef43f6

See more details on using hashes here.

Provenance

The following attestation bundles were made for pz_rail_bpz-2.1.0-py3-none-any.whl:

Publisher: publish-to-pypi.yml on LSSTDESC/rail_bpz

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page