isce-framework / isce-framework/isce3

What should be the default `composite_release_id`?

Open
#91 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
239
Forks
90
Avg merge
13d 1h
Merged PRs (30d)
5

Description

The CRID conventions for NISAR products are documented here: https://wiki.jpl.nasa.gov/display/NISARSDS/CRID+release+notification+process

The CRID convention for post-launch releases (after R4.0.8) changed recently:

  • EMMmmp
    • Environment
      • A = ADT
      • D = Development
      • T = Test
      • P = Prod
      • S = Science Ondemand
      • E or Q = Engineering or Quick-turnaround (TBD)
    • Major has 2 numerical digits
    • minor has 2 numerical digits
    • patch has 1 numerical digit

Each of the NISAR SAS runconfigs takes a composite_release_id as an optional input parameter, defaulting to "A10000".

With the new CRID convention, this default value represents "ADT, major version 10". It doesn't seem like a good default for custom NISAR processing workflows.

Should we choose a different default CRID value? Perhaps one that can be easily recognized as a custom (invalid) CRID, like "Z00000"?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the CRID convention linked in the issue and compare the default values in share/nisar/defaults/focus.yaml, python/packages/nisar/products/writers/BaseWriterSingleInput.py, and python/packages/nisar/products/insar/InSAR_base_writer.py. Confirm the intended default with project maintainers, then ensure the chosen value is applied consistently at all three locations.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.