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

Standardize Reader Arguments #816

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

srikanth-kumar
Copy link
Collaborator

@srikanth-kumar srikanth-kumar commented Nov 5, 2024

This PR focuses on standardizing the arguments in the call function for GeoIPS readers.

All of the reader plugins have the following common arguments in their call function:

  1. fnames
  2. area_def = None
  3. metadata_only =False
  4. chans = None
  5. self_register = False

The following are the readers with additional arguments or the ones with slightly different call signature.

  1. abi_l2_netcdf : has chans set to False
  2. ssmi_binary : has chans set to False
  3. ssmis_binary : has chans set to False
  4. ahi_hsd : has additional argument test_arg="AHI Default Test Arg" for logging purposes
  5. amsr_netcdf : has additional argument test_arg="AMSR2 Default Test Arg" for logging purposes
  6. viirs_netcdf : has additional attribute called resample = False

All of the above listed changes have been made, except for the last one.

Related Issues

closes NRLMMD-GEOIPS/geoips#805

Testing Instructions

for test_args removal :

(see Output section below to view log file of a successful run)

  • geoips/tests/scripts/ahi.tc.WV.geotiff.sh
  • geoips/tests/scripts/amsr2.config_based_no_compare.sh
  • geoips/tests/scripts/amsr2.config_based_no_compare_full.sh
  • geoips/tests/scripts/amsr2.config_based_overlay_output_low_memory.sh
  • geoips/tests/scripts/amsr2.tc.89H-Physical.imagery_annotated.sh

(see Output section below to view log file of a successful run but with invalid image comparison)

The test log file would return non-zero number due to bad image comparison. The procflow does its job successfully.

  • geoips/tests/scripts/amsr2.config_based_overlay_output.sh
  • geoips/tests/scripts/amsr2.tc.89H-Physical.histogram_netcdf.sh

for changing chans = False to chans = None:

  • abi_l2_netcdf :
  • ssmis_binary : NRL has not released test data for this reader. To be tested by NRL reviewers internally.
  • ssmi_binary : NRL has not released test data for this reader. To be tested by NRL reviewers internally.

Reviewers: Please confirm all required testing/documentation has been completed prior to approving.

Remove lines that are not applicable, explain if you select "NO REQUIRED"

  • Required existing tests pass (Please check the testing instructions for specifics)
  • NO REQUIRED unit tests (relevant product procflows would be sufficient)
  • NO REQUIRED integration tests (relevant product procflows would be sufficient)
  • NO REQUIRED documentation (explain why not required)
  • Required release notes added for new/modified functionality
  • NO REQUIRED release notes (explain why not required)
  • Required updates to other repos complete
  • NO REQUIRED updates to other repos (explain why not required)

https://github.com/NRLMMD-GEOIPS/.github/blob/main/.github/review-template.md

Summary

Output

log file of a successful run but with valid image comparison

log file of a successful run but with invalid image comparison

@srikanth-kumar srikanth-kumar added the order based procflow Related to the in-progress order based procflow label Nov 5, 2024
@srikanth-kumar srikanth-kumar self-assigned this Nov 5, 2024
@srikanth-kumar srikanth-kumar linked an issue Nov 5, 2024 that may be closed by this pull request
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
order based procflow Related to the in-progress order based procflow
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Collect a list of all arguments for readers
2 participants