Skip to main content
Space Telescope Science Institute Roman Telescope Logo

Nancy Grace Roman Space Telescope Calibration Pipeline

PyPI Python Support Powered by STScI Powered by Astropy pre-commit ruff build tests readthedocs codecov

This package (romancal) processes uncalibrated data from the Nancy Grace Roman Space Telescope (Roman). The pipeline performs a series of calibration steps that result in standard data products usable for science.

Detailed explanations of specific calibration stages, reference files, and pipeline builds can be found on the ReadTheDocs pages and RDox.

Quick Start

1. Install the Pipeline

We recommend using an isolated Python environment to install romancal. Python "environments" are isolated Python installations, confined to a single directory, where you can install packages, dependencies, and tools without cluttering your system Python libraries. You can manage environments with mamba / conda, virtualenv, uv, etc.

These instructions assume you are creating Conda environments with the mamba command (see Miniforge for installation instructions); to use conda instead, simply replace mamba with conda in the following commands.

First, create an empty environment with Python installed:

mamba create -n romancal_env python=3.13

Then, activate that environment (necessary to be able to access this isolated Python installation):

mamba activate romancal_env

Finally, install romancal into the environment:

pip install romancal

Without a specified version, pip defaults to the latest released version that supports your environment. To install a specific version of romancal, explicitly set that version in your pip install command:

pip install romancal==0.22.0

To install a different version of romancal, simply create a new environment for that version:

mamba create -n romancal0.22_env python=3.13
mamba activate romancal0.22_env
pip install romancal==0.22

mamba create -n romancal0.20_env python=3.12
mamba activate romancal0.20_env
pip install romancal==0.20

Option: Build Pipeline Directly from Source Code

To install the latest unreleased (and unstable) development version directly from the source code on GitHub:

pip install git+https://github.com/spacetelescope/romancal

Option: Install Exact Operational Environment

There may be occasions where you need to replicate the exact environment used for canonical calibration operations by STScI (e.g. for validation testing or debugging issues). We package releases for operations as environment snapshots that specify exact versions for both the pipeline and all dependencies.

See the DMS Operational Build Versions table for the version of the pipeline corresponding to each operational build. For example, use romancal==0.22.0 for DMS build 26Q2_B21. Also note that Linux and macOS systems require different snapshot files:

mamba env create --file https://ssb.stsci.edu/stasis/releases/romancal/ROMANDP-0.20.0/delivery/latest-py312-macos-arm64.yml
mamba activate ROMANDP-0.20.0-1-py312-macos-arm64

2. Set up the Calibration Reference Data System (CRDS)

Before running the pipeline, you must first set up your local machine to retrieve files from the Calibration Reference Data System (CRDS) CRDS provides calibration reference files for several telescopes, including Roman.

Set CRDS_SERVER_URL and CRDS_PATH to run the pipeline with access to reference files from CRDS:

export CRDS_SERVER_URL=https://roman-crds.stsci.edu
export CRDS_PATH=$HOME/data/crds_cache/

The pipeline will automatically download individual reference files and cache them in the CRDS_PATH directory. Expect to use 50 gigabytes (or more) of disk space for reference files, depending on the instrument modes in use.

To use a specific CRDS context other than that automatically associated with a given pipeline version, explicitly set the CRDS_CONTEXT environment variable:

export CRDS_CONTEXT=roman_0046.pmap

3. Run the Pipeline

Once installed, the pipeline allows users to run and configure calibration themselves for custom processing of Roman Telescope data, either from the command line with strun or from Python with pipeline and step functions and classes in the romancal package. Additionally, the romancal package provides Roman Telescope datamodel classes, the recommended method for reading and writing Roman Telescope data files in Python.

Code Contributions

romancal is an open source package written in Python. The source code is available on GitHub. New contributions and contributors are very welcome! Please read CONTRIBUTING.md.

We strive to provide a welcoming community by abiding with our CODE_OF_CONDUCT.md.

See TESTING.md for instructions on automated testing.

DMS Operational Build Versions

The table below provides information on each release of the romancal package and its relationship to software builds used in STScI Roman Telescope DMS operations. Each romancal tag was released on PyPI on the date given in Date.

romancal tag DMS build CRDS_CONTEXT Date Notes
1.2.0 27Q1_B24 077 Nov 2026 Release for Build 27Q1_B24 (Build 24)
1.1.0 26Q4_B23 058 Aug 2026 Release for Build 26Q4_B23 (Build 23)
1.0.3 26Q3_B22.6 077 Oct 2026 Release for Build 26Q3_B22.6 (Build 22)
1.0.2 26Q3_B22.3 065 Sep 2026 Release for Build 26Q3_B22.3 (Build 22)
1.0.1 26Q3_B22.1 055 Jun 2026 Release for Build 26Q3_B22.1 (Build 22)
1.0.0 26Q3_B22 051 May 2026 Release for Build 26Q3_B22 (Build 22)
0.22.0 26Q2_B21 046 Feb 2026 Release for Build 26Q2_B21 (Build 21)
0.21.0 26Q1_B20 090 Nov 2025 Release for Build 26Q1_B20 (Build 20)
0.20.1 25Q4_B19 088 Aug 2025 Release for Build 25Q4_B19 (Build 19)
0.20.0 25Q4_B19 088 Aug 2025 Release for Build 25Q4_B19 (Build 19)
0.19.0 25Q3_B18 083 May 2025 Release for Build 25Q3_B18 (Build 18)
0.18.0 25Q2_B17 072 Feb 2025 Release for Build 25Q2_B17 (Build 17)
0.17.0 25Q1_B16 065 Nov 2024 Release for Build 25Q1_B16 (Build 16)
0.16.3 24Q4_B15 063 Aug 2024 Release for Build 24Q3_B15 (Build 15)
0.16.2 24Q4_B15 063 Aug 2024 Release for Build 24Q3_B15 (Build 15)
0.16.1 24Q4_B15 063 Aug 2024 Release for Build 24Q3_B15 (Build 15)
0.16.0 24Q4_B15 063 Aug 2024 Release for Build 24Q3_B15 (Build 15)
0.15.1 24Q3_B14 058 May 2024 Release for Build 24Q3_B14 (Build 14)
0.15.0 24Q3_B14 058 May 2024 Release for Build 24Q3_B14 (Build 14)
0.14.0 24Q2_B13 056 Feb 2024 Release for Build 24Q2_B13 (Build 13)
0.13.0 24Q1_B12 052 Nov 2023 Release for Build 24Q1_B12 (Build 12)
0.12.0 23Q4_B11 051 Aug 2023 Release for Build 23Q4_B11 (Build 11)
0.11.0 23Q3_B10 047 May 2023 Release for Build 23Q3_B10 (Build 10)
0.10.0 23Q2_B9 041 Feb 2023 Release for Build 23Q2_B9 (Build 9)
0.9.0 23Q1_B8 039 Nov 2022 Release for Build 23Q1_B8 (Build 8)
0.8.1 22Q4_B7 038 Aug 2022 Release for Build 22Q4_B7 (Build 0.7)
0.8.0 22Q4_B7 038 Aug 2022 Release for Build 22Q4_B7 (Build 0.7)
0.7.1 22Q3_B6 032 May 2022 Release for Build 22Q3_B6 (Build 0.6)
0.7.0 22Q3_B6 032 May 2022 Release for Build 22Q3_B6 (Build 0.6)
0.6.0 0.5 030 Mar 2022 Release for Build 0.5
0.5.0 0.4 023 Dec 2021 Release for Build 0.4
0.4.2 0.3 011 Sep 2021 Release for Build 0.3
0.3.1 0.2 007 Jun 2021 Release for Build 0.2 CRDS tests
0.3.0 0.2 007 May 2021 Release for Build 0.2
0.2.0 0.1 004 Mar 2021 Release for Build 0.1
0.1.0 0.0 003 Nov 2020 Release for Build 0.0

Metadata

Release files for romancal 1.2.0

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

Source distribution (sdist)

Source distribution for romancal 1.2.0
File Size Uploaded Provenance Actions
romancal-1.2.0.tar.gz 2.8 MB Without provenance Details for romancal-1.2.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for romancal 1.2.0
File Interpreter ABI Platform Actions
romancal-1.2.0-py3-none-any.whl Python 3 none any Details for romancal-1.2.0-py3-none-any.whl

Total release size: 3.6 MB

Release files / romancal-1.2.0.tar.gz

Download URL romancal-1.2.0.tar.gz
Size 2.8 MB
Tags Source
SHA-256 checksum
How to use checksums
cbfe5a21fc08221c000c847d4536cee5fdcb8fbf9c64b935deafface5334fd94
BLAKE2b-256 checksum
How to use checksums
46b43e2ab470af714203f9f285946e3b533daee951fa3455e3e4bee8674dc304
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / romancal-1.2.0-py3-none-any.whl

Download URL romancal-1.2.0-py3-none-any.whl
Size 770.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5c9b2bcf60866877b8f8e7b70e5c8625464c6e01cf3db5ea8e60320a8cc4b050
BLAKE2b-256 checksum
How to use checksums
5e4365ee4fb34a2a33f53c872fac2612d6cdd602fab7c009953c3e6775596a37
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for romancal 1.2.0

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.

No provenance found

None of the files in this release were uploaded with provenance metadata.

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.

Release history Release notifications | RSS feed

This release

1.2.0 This release

2 release files No provenance

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