Skip to content

Commit 96688f4

Browse files
authored
Merging branch 2026.2.x into main
This branch includes all new notebooks and workflows, updated notebooks, and requirement files in support of release Nexus 2026.2. All CI tests pass now.
2 parents 8b3f0a7 + ce04b24 commit 96688f4

87 files changed

Lines changed: 352473 additions & 1456 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/notebook-on-demand.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -336,4 +336,3 @@ jobs:
336336

337337

338338

339-

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,3 @@
22
.DS_Store
33
mastDownload
44
*.asdf
5-
*.ecsv

CITATION.cff

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
cff-version: 2026.2
2+
message: "If you use these notebooks in your work, please cite it using the following metadata."
3+
authors:
4+
- family-names: "Barnes"
5+
given-names: "Amethyst"
6+
orcid: "https://orcid.org/0009-0001-0447-0793"
7+
- family-names: "Bianco"
8+
given-names: "Sam"
9+
orcid: ""
10+
- family-names: "Cherinka"
11+
given-names: "Brian"
12+
orcid: "https://orcid.org/0000-0002-4289-7923"
13+
- family-names: "Choi"
14+
given-names: "Ami"
15+
orcid: ""
16+
- family-names: "Desjardins"
17+
given-names: "Tyler"
18+
orcid: "https://orcid.org/0000-0001-6905-1859"
19+
- family-names: "Diaz"
20+
given-names: "Rosa"
21+
orcid: "https://orcid.org/0000-0002-2269-239X"
22+
- family-names: "Dutkiewicz"
23+
given-names: "Thomas"
24+
orcid: "https://orcid.org/0009-0003-8874-4679"
25+
- family-names: "Han"
26+
given-names: "Eunkyu"
27+
orcid: "https://orcid.org/0000-0001-9797-0019"
28+
- family-names: "Khandrika"
29+
given-names: "Harish"
30+
orcid: "https://orcid.org/0000-0002-9011-0216"
31+
- family-names: "Lajoie"
32+
given-names: "Charles-Philippe"
33+
orcid: "https://orcid.org/0009-0003-3993-8338"
34+
- family-names: "Louie"
35+
given-names: "Dana"
36+
orcid: "https://orcid.org/0000-0002-2457-272X"
37+
- family-names: "Mehta"
38+
given-names: "Vihang"
39+
orcid: "https://orcid.org/0000-0001-7166-6035"
40+
- family-names: "Morris"
41+
given-names: "Brett"
42+
orcid: "https://orcid.org/0000-0003-2528-3409"
43+
- family-names: "Otor"
44+
given-names: "Justin"
45+
orcid: ""
46+
- family-names: "Price"
47+
given-names: "Sedona"
48+
orcid: "https://orcid.org/0000-0002-0108-4176"
49+
- family-names: "Sánchez"
50+
given-names: "Javier"
51+
orcid: "https://orcid.org/0000-0001-8514-4350"
52+
- family-names: "Schultz"
53+
given-names: "Will C."
54+
orcid: "https://orcid.org/0000-0003-1796-9849"
55+
- family-names: "Shahbandeh"
56+
given-names: "Melissa"
57+
orcid: "https://orcid.org/0000-0002-9301-5302"
58+
- family-names: "Sharma"
59+
given-names: "Sanjib"
60+
orcid: "https://orcid.org/0000-0002-0920-809X"
61+
- family-names: "Wilson"
62+
given-names: "Robby"
63+
orcid: ""
64+
- family-names: "Wu"
65+
given-names: "John F."
66+
orcid: "https://orcid.org/0000-0002-5077-881X"
67+
68+
abstract: " The Roman Notebooks. Jupyter notebooks "
69+
repository-code: "https://github.com/spacetelescope/roman_notebooks"
70+
71+
72+
title: "Roman Notebooks"
73+
version: 2026.2.0
74+
doi: 10.5281/zenodo.17179608
75+
license: BSD-3-Clause
76+
date-released: 2026-09-15
77+
type: software
78+
url: "https://github.com/spacetelescope/roman_notebooks"

images/crds_workflow.jpg

133 KB
Loading

images/wfi-data-sim.jpg

5.88 KB
Loading

markdown/roman_Intro.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Introduction to the Nancy Grace Roman Space Telescope
2+
3+
The Nancy Grace Roman Space Telescope (Roman) is a NASA flagship mission with an expected launch in mid-2026. Roman is equipped with the Wide Field Instrument (WFI) as its primary instrument, as well as the Roman Coronagraph. The WFI has a large field of view, approximately 200 times larger than that of the Hubble Space Telescope Wide Field Camera 3 infrared detector. When compared to other space observatories, like Hubble Space Telescope, the scale of data collection will be magnitudes larger than what has been possible before. For example, in the first five years of operations, the estimated volume of Roman's data archive is 20 petabytes (PB), which is roughly 20,000 terabytes (TB), compared to Hubble's 172 TB during 30 years of operations.
4+
5+
During its mission, Roman will conduct different surveys of the sky including the Galactic Bulge Time-Domain Survey, High-Latitude Time-Domain Survey, High-Latitude Wide-Area Survey, and the Galactic Plane Survey. Each of these surveys will contribute to our understanding of the Universe, as well as serving Roman's primary missions of studying and discovering exoplanets, and measuring dark matter and dark energy.
6+
7+
Data from Roman will be stored and available to users via the Roman Archive in the Barbara A. Mikulski Archive for Space Telescopes (MAST), with WFI data stored in Advanced Scientific Data Format (ASDF). Instructions on how to access and utilize the Roman data is available throughout the Roman Nexus Workflows and Tutorial Notebooks.
8+
9+
Welcome to the Nancy Grace Roman Space Telescope!
10+
11+
12+
## For Additional Information About Roman’s Mission Explore:
13+
- [Roman Documentation (RDox)](https://roman-docs.stsci.edu/)
14+
- [Roman's Mission](https://science.nasa.gov/mission/roman-space-telescope/)
15+
- [Roman Space Telescope](https://www.stsci.edu/roman)

markdown/tutorials.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Below is the current set of Notebook Tutorials available in the Nexus. Each tuto
1919

2020
### Data Access and Exploration
2121

22-
- [**Catalog Database Access**](../notebooks/cayalog_database_access/catalog_database_access.ipynb)
22+
- [**Catalog Database Access**](../notebooks/catalog_database_access/catalog_database_access.ipynb)
2323

2424
Access and query a wide diversity of Roman catalogs from MAST databases.
2525

@@ -60,6 +60,15 @@ Below is the current set of Notebook Tutorials available in the Nexus. Each tuto
6060
Combine multiple Level 2 data products into a Level 3 distortion-corrected and co-added image using the Roman WFI science calibration pipeline, RomanCal.
6161

6262
*Science Workflow(s)*: [WFI Data Simulation](./workflows/wfi-data-sim.md)
63+
64+
- [**CRDS Reference Files**](../notebooks/crds_reference_files/README.md)
65+
66+
- Understand the structure, content, and usage of Calibration Reference Data System.
67+
- Learn How to get reference files from CRDS
68+
- Explore each major reference file type in detail.
69+
70+
71+
*Reference Files Workflow*: [**CRDS Reference Files Exploration**](./workflows/crds-reference-files.md)
6372

6473
- [**WFI TVAC Bright Star Data**](../notebooks/ground_test_analysis/wfi_tvac_brightstar.ipynb)
6574

markdown/workflows.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,20 @@ Workflows are designed to help users explore Roman-style analysis patterns in th
66

77
## WFI Workflows (Early Access)
88

9-
The Early Access release currently includes three WFI-focused Science Workflows:
9+
The Early Access release currently includes four WFI-focused Science Workflows:
10+
11+
- [Quickstart Workflow](./workflows/Intro_Workflow.md)
1012
- [WFI Data Simulation](./workflows/wfi-data-sim.md)
1113
- [WFI Data Analysis](./workflows/wfi-data-analysis.md)
1214
- [WFI Observation Planning](./workflows/wfi-obs-plan.md)
15+
- [CRDS Reference File Exploration](./workflows/crds-reference-files.md)
1316

14-
Together, these workflows demonstrate how Roman tools can be used for pipeline-level data simulation, exploratory analysis of simulated WFI products within the Nexus environment, and proposal planning.
17+
Together, these workflows demonstrate how Roman tools can be used for pipeline-level data simulation, exploratory analysis of simulated WFI products and calibration reference data within the Nexus environment and proposal planning.
1518

16-
Each workflow highlights a different aspect of the platform ecosystem—from generating synthetic data and processing them through the Roman calibration pipeline to performing basic measurements on exposure-level products and evaluating observing strategies. While the current materials focus on WFI-imaging investigations, they also include an introductory spectroscopic example within the Data Analysis workflow, with additional spectroscopic content planned for future updates. Two further workflows—one covering **time-domain analysis** and another focused on **WFI TVAC data**—are in development and expected to be added in **early 2026**.
19+
Each workflow highlights a different aspect of the platform ecosystem—from generating synthetic data and processing them through the Roman calibration pipeline to performing basic measurements on exposure-level products and evaluating observing strategies. While the current materials focus on WFI-imaging investigations, they also include an introductory spectroscopic example within the Data Analysis workflow, with additional spectroscopic content planned for future updates. One further workflow covering **time-domain analysis** is in development and expected to be added in **summer 2026**.
1720

1821
## Using Workflows
1922
Workflows are composed of individual [Notebook Tutorials](./tutorials.md), each focused on a specific tool or analysis step. Users may work through an entire workflow sequentially or use the tutorials independently, depending on their goals. If you would like to modify the material for a custom workflow, first copy it into your personal home directory or team home directory.
2023

2124
---
22-
*Last Updated: December 2025*
25+
*Last Updated: July 2026*
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Intro Nexus Workflow
2+
Welcome to the Roman Research Nexus, an open platform which brings data from NASA's flagship missions, the Nancy Grace Roman Space Telescope (Roman), into the hands of everyone. Whether you're getting your start in citizen science, completing course work, or just wanting to look at some new images from Roman, this is the place to start.
3+
4+
This workflow has preselected tutorial notebooks which are best suited for people either outside of the field of astronomy, or just beginning their astronomy education. These tutorial notebooks will teach the process by which one can access, filter, and visualize Roman data.
5+
6+
- [**Jupyter Notebook Tutorial)**](../../markdown/jupyter.md)
7+
8+
Start here if you haven't already. Explore the basics of working in Jupyter and learn all the skills you'll need to be able to run the notebooks.
9+
10+
## Workflow Overview
11+
12+
- [**Roman Mission Introduction**](../../markdown/roman_Intro.md)
13+
14+
Before we start utilizing the data, let's learn about where the data comes from. Explore this mission and get an idea of the type of technology and instrumentation we'll be working with. Gain a background on the purpose and details of the Roman Mission and its goals.
15+
16+
- [**Data Discovery and Access**](../../notebooks/data_discovery_and_access/data_discovery_and_access.ipynb)
17+
18+
Now that you know what Roman is, let's figure out how to find its data. Due to the vast amount of data which we will be receiving from the telescope, scientists working with data from Roman will utilize cloud-based storage processing. These cloud services are limited to registered MyST users only; regardless, this notebook will teach you how to search for and retrieve data from Roman's Wide Field Instrument (WFI), as well as data from other missions (such as the Hubble Space Telescope) from the Barbara A. Mikulski Archive for Space Telescopes (MAST). With this notebook you'll be able to search for observations of celestial objects in MAST, and allow you to take the data you found into the next notebooks.
19+
20+
- [**Working With ASDF**](../../notebooks/working_with_asdf/working_with_asdf.ipynb)
21+
22+
Now that we have found our data let's figure out how to open and handle it. Roman stores its data using the Advanced Scientific Data Format (ASDF), so in this notebook you will learn about tools allowing you to search, load, and read ASDF files. Additionally learn about the process by which Roman Data are formatted and categorized as you explore ASDF metadata. By the end of this notebook you'll have an understanding of the structures and functions related to the data produced by Roman, enabling you to take on new data yourself.
23+
24+
- [**Data Visualization**](../../notebooks/data_visualization/data_visualization.ipynb)
25+
26+
You've learned about how find the data and how the products are formatted; now let's start to work with those data products. In this notebook, you will take the methods you learned to access data and apply it to methods of visualization so that we'll be able to look at the images and data Roman is providing. Additionally, you will learn about some known instrument artifacts that can occur with the WFI. Explore different visualization techniques to gain all the tools you'll need to look at all the amazing images from Roman.
27+
28+
29+
- [**Footprint Visualization**](../../notebooks/footprint_visualization/footprint_visualization.ipynb)
30+
31+
Now, let's explore the kinds of science Roman will do. In this notebook, you will learn about the various surveys that the Roman Space Telescope will complete during its mission. Furthermore, you will be able to visualize Roman survey footprints on the sky to determine whether, when, and how Roman may observe an astronomical source. With this final tutorial in the workflow, take the step towards your own science and explore with these sources and tools yourself.
32+
33+
34+
35+
## Caveats and Limitations
36+
- This workflow is primarily for individuals who do not have advanced degrees in astronomy, providing a curated selection of tutorials utilized by professional astronomers, and additionally providing explanations of concepts when possible to make certain ideas more accessible.
37+
- It is highly recommended to explore the resources linked throughout the notebooks in order to gain a better grasp of the ideas and concepts discussed in this workflow.
38+
39+
40+
---
41+
*Last Updated: July 2026*
Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# CRDS Reference Files
2+
3+
This science workflow guides users through understanding the structure, content, and
4+
usage of Calibration Reference Data System (CRDS) reference files for the Roman Wide
5+
Field Instrument (WFI).
6+
7+
The notebooks in this workflow are designed as standalone tutorials but can
8+
be followed sequentially for a complete introduction to how reference files are
9+
retrieved, inspected, and visualized.
10+
11+
## Workflow Overview
12+
13+
### General CRDS Introduction
14+
15+
- [crds_reference_files.ipynb](../../notebooks/crds_reference_files/crds_reference_files.ipynb)
16+
17+
- Learn what CRDS is, how reference files are matched and delivered, and how to use `crds.getreferences()` and `crds.getrecommendations()`.
18+
19+
### Reference File Inspection Fundamentals
20+
21+
- [crds_reference_files.ipynb](../../crds_reference_files/crds_reference_files.ipynb) (first part) + individual reference file notebooks
22+
23+
Understand the common structure of Roman reference files using `roman_datamodels` and the `.info()` method.
24+
25+
### Individual Reference File Notebooks
26+
27+
Explore each major reference file type in detail:
28+
29+
| Reference File | Purpose | Key Concepts Covered | Notebook |
30+
|----------------|---------|----------------------|----------|
31+
| **MASK** (Bad Pixel Mask) | DQ flags and bad pixel identification | `dq` array, bitwise flags, flagged pixel statistics | [bad_pixels_mask_reffile.ipynb](../../notebooks/crds_reference_files/bad_pixels_mask_reffile.ipynb) |
32+
| **DARK** | Dark current correction | Pixel-by-pixel and frame-by-frame dark current values per detector readout mode | [dark_reffile.ipynb](../../notebooks/crds_reference_files/dark_reffile.ipynb) |
33+
| **SATURATION** | Saturation thresholds | Per-pixel thresholds, flag handling | [saturation_reffile.ipynb](../../notebooks/crds_reference_files/saturation_reffile.ipynb) |
34+
| **REFPIX** | Reference pixel correction | Frequency-dependent coefficients (`alpha`, `gamma`, `zeta`) | [reference_pixel_reffile.ipynb](../../notebooks/crds_reference_files/reference_pixel_reffile.ipynb) |
35+
| **DISTORTION** | Astrometric distortion model | Astropy `CompoundModel`, grid evaluation, vector fields | [distortion_reffile.ipynb](../../notebooks/crds_reference_files/distortion_reffile.ipynb) |
36+
| **PHOTOM** | Photometric calibration | conversion factors for putting pixel values into physical units | [photom_reffile.ipynb](../../notebooks/crds_reference_files/photom_reffile.ipynb) |
37+
| **GAIN** | DN to electrons conversion | Per-pixel gain maps, amplifier structure | [gain_reffile.ipynb](../../notebooks/crds_reference_files/gain_reffile.ipynb) |
38+
| **READNOISE** | Read noise characterization | Per-pixel read noise maps | [readnoise_reffile.ipynb](../../notebooks/crds_reference_files/readnoise_reffile.ipynb) |
39+
| **AREA** | Pixel solid angle | Pixel area maps in steradians | [area_reffile.ipyn](../../notebooks/crds_reference_files/area_reffile.ipynb) |
40+
| **PSF / ePSF** | Empirical point spread function | Multi-dimensional ePSF stamps, extended PSF | [psf_reffile.ipynb](../../notebooks/crds_reference_files/psf_reffile.ipynb) |
41+
| **LINEARITY** family | Non-linearity correction | `LINEARITY`, `INVERSELINEARITY`, `INTEGRALNONLINEARITY` (per-amplifier lookup tables) | [linearity_reffile.ipynb](../../notebooks/crds_reference_files/linearity_reffile.ipynb) |
42+
43+
44+
## Suggested Learning Path
45+
46+
1. Start with the general **CRDS Reference Files** notebook.
47+
3. Go through the individual reference file notebooks in roughly this order:
48+
- MASK -> DARK -> SATURATION -> FLAT (foundational)
49+
- GAIN -> READNOISE -> AREA -> DISTORTION (detector characterization)
50+
- LINEARITY family (important for flux accuracy)
51+
- PHOTO (photometric calibration)
52+
- REFPIX, PSF/ePSF (more specialized)
53+
4. Return to the general CRDS notebook as needed for context.
54+
55+
56+
<img src="https://raw.githubusercontent.com/spacetelescope/roman_notebooks/refs/heads/main/images/crds_workflow.jpg" alt="CRDS Workflow" width="250" />
57+
58+
59+
## How to Use This Workflow
60+
61+
- Work through the notebooks sequentially for a comprehensive understanding.
62+
- Use individual notebooks independently when you need to inspect a specific reference file.
63+
- All notebooks follow a consistent structure
64+
65+
## Related Workflows
66+
67+
- **WFI Data Simulation** — Uses many of these reference files via Roman-I-Sim and CRDS.
68+
- **WFI Data Analysis** — Uses calibrated data products that depend on these reference files.
69+
- **Exposure Pipeline** tutorial — Shows where these reference files are actually applied in `romancal`.
70+

0 commit comments

Comments
 (0)