Skip to main content

No project description provided

Project description

RAIL sompz

Template DOI codecov PyPI GitHub Workflow Status

sompz - RAIL estimator, summarizer, and classifier using the SOMPZ method described in Buchs, Davis, et al. 2019, Sánchez, Raveri, Alarcon, Bernstein 2020, Myles, Alarcon et al. 2021 and Campos, et al. 2024.

The main product is the galaxy ensemble tomographic bin assignments and associated redshift distributions $n(z)$, which are output for a sample as a qp ensemble. The code additionally saves the two Self-Organizing Maps (SOMs) constructed for $n(z)$ inference and assignment indices of the input galaxy samples to their respective SOMs.

The SOMPZ algorithm generates redshift distributions for a sample of galaxies with a multi-step inference formalism. Based on observations of a wide-field imaging dataset catalog and a deep-field imaging dataset catalog (traditionally lower-noise optical bands and additional near-infrared bands), the algorithm takes three primary tabular data inputs:

  • spec_data: a catalog with secure redshifts, deep-field photometry, and simulated wide-field photometry
  • balrog_data : a catalog with deep-field photometry and simulated wide-field photometry
  • wide_data: a catalog with wide-field photometry

In practice, spec_data is a subset of balrog_data.

These catalogs are used to train two SOMs: one built with deep-field photometry and the other built with wide-field photometry.

Once all samples are assigned to the wide SOM and spec_data and balrog_data are assigned to the deep SOM the wide SOM cells can be grouped into tomographic bins via a tomographic binning algorithm. The redshift distributions are computed as follows:

$$ n(z|\hat{b}, \hat{s}) = \sum_{\hat{c} \in \hat{b}} \sum_{c \in \hat{c}} p(z|c, \hat{s}) p(c|\hat{c}, \hat{s}) p(\hat{c}| \hat{s}) $$

RAIL: Redshift Assessment Infrastructure Layers

RAIL is a flexible software library providing tools to produce at-scale photometric redshift data products, including uncertainties and summary statistics, and stress-test them under realistically complex systematics. A detailed description of RAIL's modular structure is available in the Overview on ReadTheDocs.

RAIL serves as the infrastructure supporting many extragalactic applications of the Legacy Survey of Space and Time (LSST) on the Vera C. Rubin Observatory, including Rubin-wide commissioning activities. RAIL was initiated by the Photometric Redshifts (PZ) Working Group (WG) of the LSST Dark Energy Science Collaboration (DESC) as a result of the lessons learned from the Data Challenge 1 (DC1) experiment to enable the PZ WG Deliverables in the LSST-DESC Science Roadmap (see Sec. 5.18), aiming to guide the selection and implementation of redshift estimators in DESC analysis pipelines. RAIL is developed and maintained by a diverse team comprising DESC Pipeline Scientists (PSs), international in-kind contributors, LSST Interdisciplinary Collaboration for Computing (LINCC) Frameworks software engineers, and other volunteers, but all are welcome to join the team regardless of LSST data rights.

Installation

Installation instructions are available under Installation on ReadTheDocs.

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 make use of the ideas or software here in any publication, you must cite this repository https://github.com/LSSTDESC/RAIL as "LSST-DESC PZ WG (in prep)" with the Zenodo DOI. Please consider also inviting the developers as co-authors on publications resulting from your use of RAIL by making an issue. Additionally, several of the codes accessible through the RAIL ecosystem must be cited if used in a publication. A convenient list of what to cite may be found under Citing RAIL on ReadTheDocs.

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_sompz-0.0.4.tar.gz (2.7 MB view details)

Uploaded Source

Built Distribution

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

pz_rail_sompz-0.0.4-py3-none-any.whl (37.3 kB view details)

Uploaded Python 3

File details

Details for the file pz_rail_sompz-0.0.4.tar.gz.

File metadata

  • Download URL: pz_rail_sompz-0.0.4.tar.gz
  • Upload date:
  • Size: 2.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pz_rail_sompz-0.0.4.tar.gz
Algorithm Hash digest
SHA256 f91fa463f651add08f2cb339a7fbdb903598672a752f524c0f3161f8cb4ef82e
MD5 818d517d62d37d49ab4d7608789e5f0e
BLAKE2b-256 b27af748922151d3abf189481e4c36da06aef82cd9c824682d76a97a8e231ce7

See more details on using hashes here.

Provenance

The following attestation bundles were made for pz_rail_sompz-0.0.4.tar.gz:

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

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_sompz-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: pz_rail_sompz-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 37.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pz_rail_sompz-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 86f33174245bb0f6c09433e0118c9e4152b71f54489e4ac472f79de33a0d324b
MD5 ca20d1c7a47b1562ae266081858779db
BLAKE2b-256 e81fd2f6efebfd73874889d11ca15075af2979bd25797843a7954a752d45ba88

See more details on using hashes here.

Provenance

The following attestation bundles were made for pz_rail_sompz-0.0.4-py3-none-any.whl:

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

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