nasa / harmony-browse-image-generator

Other
2 stars 4 forks source link

DAS-2166: Improve HyBIG documentation and notebooks #12

Closed flamingbear closed 4 months ago

flamingbear commented 4 months ago

Description

Add information to the HyBIG README regarding default behavior for regridding, tiling, coloring and customizations.

Update example notebook to match current HyBIG functionality

Jira Issue ID

DAS-2166

Local Test Steps

Pull this branch, create a python environment with the packages in docs/requirements.txt Run the notebook and see that all of the output looks correct.

Read the README for clarity and understanding.

Check Notebook for typos or bad wording.

PR Acceptance Checklist

No release needed since this is only documentation related.

flamingbear commented 4 months ago
  • I think the origin of this ticket came from realising what the default behaviour for scale extent wasn't really stated anywhere.

No, but I said I'd put that in.

flamingbear commented 4 months ago

No, but I said I'd put that in.

@owenlittlejohns Ok, I added that information to the README.md I don't think I want to copy it into the notebook. I might update the notebook to alert the reader to a README.md file