Roman WFI Reference File Pipeline

Caution

The code in this repository is under heavy development and not currently intended for widespread use.

If you have questions, see the CONTRIBUTING.md.

Installation

It is recommended to begin with a clean environment, such as:

conda create -n wfirefpipe python=3.12

To install the package for general usage:

pip install .

OR To install the package for development and testing:

pip install -e .[docs,test]

This will also install all of the dependencies.

NOTE: Installing this way uses the dependencies outlined in pyproject.toml. These dependencies mirror requirements.txt. If you would like to install with custom dependencies, just update them in requirements.txt and pip install -r requrements.txt

Users must create a config.yml living at: /wfi_reference_pipeline/src/wfi_reference_pipeline/config/config.yml Use example_config.yml in the same directory as a template.

Contributing

Warning

We are not currently accepting external Pull Requests. However, we plan to use the guidelines below in the near future.

To contribute to this project, please become familiar with our Contributing Guide

Documentation

To get the full documentation, install the package as described above, install sphinx, then go to the /src/docs/ directory and run:

make html

The documentation can then be found in doc/build/html/index.html.

Slack Integration

To use the Slack notifications, you must set up a Slack token. When you have a token, you can point to it with the environment variable WFI_SLACK_TOKEN.

Updating reference files on CRDS

Go to your .bash_profile and set environment variables to determine the crds state.

This is for the Roman test instance of CRDS.

export CRDS_SERVER_URL="https://roman-crds.stsci.edu"
export CRDS_PATH="/PATH/TO/ops_crds/"

Start with a clean environment where you will get the latest versions of romancal, roman attribute dictionary, and roman data models.

conda create -yn VMdevRFP_update_refs ipython
conda activate VMdevRFP_update_refs
pip install romancal crds

By doing this pip install you will get the latest released versions since this workflow is setup to replace old reference files with the most current.

Now sync crds to get all of the mappings updated.

crds sync --all

See the update_reference_files.py script in examples that was done for Build 17 in April 2025. Also see

navigate to central store's roman directory, then:
./RFP/DEV/py_scripts_notebooks/build_pyscripts/update_all_TVAC_CRDS_ref_files.py