Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expose public API for making test data #299

Open
braingram opened this issue Dec 22, 2023 · 3 comments
Open

Expose public API for making test data #299

braingram opened this issue Dec 22, 2023 · 3 comments
Assignees

Comments

@braingram
Copy link
Collaborator

braingram commented Dec 22, 2023

As projects begin to add support for roman data files it would be helpful to have a documented public API for making 'test' data (similar to what is currently done in romancal using the maker_utils).

See spacetelescope/astrocut#105 (comment) for a specific example where a level 2 file (with complete WCS) would be useful.

And https://github.com/spacetelescope/jdaviz/blob/e8f125ebe375f938ed3a7b2af97e1a1c3dd5b531/jdaviz/configs/imviz/tests/utils.py#L241 for another example.

@WilliamJamieson
Copy link
Collaborator

I am not sure what you mean here. There is a Public API, the roman_datamodels.maker_utils which can generate a "valid" (filled with garbage but technically correct) set of data.

@braingram
Copy link
Collaborator Author

Thanks for the reply. If the intention is for the maker_utils to be public shouldn't they be documented? I don't see any mention of them in the roman_datamodels docs: https://roman-datamodels.readthedocs.io/en/latest/search.html?q=maker_utils&check_keywords=yes&area=default

@WilliamJamieson
Copy link
Collaborator

They are for testing purposes, and are mostly considered internal to romancal for its testing and setup of data. We don't want to encourage their widespread use as while the are "valid" in the sense of the RAD schemas. They don't produce a datamodel containing anything close to actual data. That is what romancal and romanisim are intended to do. romanisim to simulate observations and romancal to take observation data and calibrate it. The maker_utils are convenience functions only. Thus we do not advertise the feature in order to avoid creating the misconception that they make anything that should be used.

@PaulHuwe PaulHuwe assigned PaulHuwe and WilliamJamieson and unassigned PaulHuwe Dec 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants