Roman Space Telescope Calibration Pipeline
Version: 1.3.0.dev26+g35a00cbdc
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,
applying various corrections to produce science-ready, calibrated output products including
individual exposures and high-level data products (mosaics, catalogs etc.).
See README.md for installation and usage instructions.
This package allows users to run and configure the calibration pipeline 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.
Note
If you have trouble installing this package, have encountered a bug while running the pipeline, or wish to request a new feature, please open an issue on GitHub or contact the Roman Telescope Help Desk.
Detailed explanations of specific calibration stages, reference files, and pipeline builds can be found on RDox.
Attention
Starting December 1st 2026, STScI will no longer test macOS x86 versions of software (Intel processors, including all Mac machines earlier than 2020).
macOS x86 builds will still be available on PyPI and installable with pip install, but will not be tested for numerical accuracy.
Going forward, software testing for macOS will only be ARM64 (Apple Silicon).
Contributing
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.
RomanCal Pipeline
- Installation
- Pipeline Levels
- Running the Pipeline
- Pipeline Steps
- Data Quality (DQ) Initialization
- Saturation Detection
- Reference Pixel Correction
- Dark Decay Correction
- WFI18 Transient Correction
- Linearity Correction
- Dark Current Subtraction
- Ramp Fitting
- Assign WCS
- Flatfield Correction
- Photometric Calibration
- Flux
- TweakReg
- SkyMatch
- Outlier Detection
- Resample
- Source Catalog
- Reference Files
- Parameters
- I/O File Conventions
- Error Propagation
Data Products Documentation
RomanCal Package Index
- Versioning Scheme
- API: Public vs Private
- Assign WCS
- Associations
- Dark Current Subtraction
- Dark Decay Correction
- Data Quality (DQ) Initialization
- Flatfield Correction
- Flux
- Linearity Correction
- Outlier Detection
- Obsevatory Orientation Utilities
- Pipeline Modules
- Ramp Fitting
- Reference File Information
- Reference Pixel Correction
- Resample
- Saturation Detection
- SkyMap
- SkyMatch
- Source Catalog
- Stpipe
- TweakReg
- Velocity Aberration
- WFI18 Transient Correction
Datamodels
Additional Information