Skip to main content

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.

Metadata

Release files for pz-rail-sompz 0.0.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pz-rail-sompz 0.0.4
File Size Uploaded Provenance
pz_rail_sompz-0.0.4.tar.gz 2.7 MB With provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for pz-rail-sompz 0.0.4
File Interpreter ABI Platform
pz_rail_sompz-0.0.4-py3-none-any.whl Python 3 none any Details

Total release size: 2.8 MB

Release files / pz_rail_sompz-0.0.4.tar.gz

Download URL pz_rail_sompz-0.0.4.tar.gz
Size 2.7 MB
Tags Source
SHA-256 checksum
How to use checksums
f91fa463f651add08f2cb339a7fbdb903598672a752f524c0f3161f8cb4ef82e
BLAKE2b-256 checksum
How to use checksums
b27af748922151d3abf189481e4c36da06aef82cd9c824682d76a97a8e231ce7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Mar 3, 2026.

Transparency log

Release files / pz_rail_sompz-0.0.4-py3-none-any.whl

Download URL pz_rail_sompz-0.0.4-py3-none-any.whl
Size 37.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
86f33174245bb0f6c09433e0118c9e4152b71f54489e4ac472f79de33a0d324b
BLAKE2b-256 checksum
How to use checksums
e81fd2f6efebfd73874889d11ca15075af2979bd25797843a7954a752d45ba88
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Mar 3, 2026.

Transparency log

Security for pz-rail-sompz 0.0.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for pz_rail_sompz-0.0.4.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Mar 3, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page