DAS-2166: Improve HyBIG documentation and notebooks #12
Conversation
There was a problem hiding this comment.
This looks great, thanks for the update.
I think there are two things I reckon could do with a quick change:
- Tracking through the notebook and check the file names. I'm seeing a bunch of stuff locally where this notebook is looking for something like "VCF5KYR_1991001_001_2018224205008.png" but the files that are present are more like "1991001_001_2018224205008.png".
- Making sure the GIBS-compatible default behaviour is explained. I think the origin of this ticket came from realising what the default behaviour for scale extent wasn't really stated anywhere. I think the README is possibly only missing the scale extent information, but the notebook would probably benefit for having all those defaults explained in the markdown for the first example.
| |- docker | ||
| |- docs | ||
| |- harmony_browse_image_generator | ||
| |- legacy-CHANGELOG.md |
There was a problem hiding this comment.
Thanks for adding these missing items. (Although, now it's making me realise we're potentially missing the description of the license file in the list below, maybe the file is self-explanatory, but might be worth mentioning it's required for NASA open-source release)
There was a problem hiding this comment.
Yes I looked at all the files and was trying to decide which ones should be described. and with license it would be.
|- license
license - license file for repository
IDK. No strong opinions, but also don't think it's necessary
There was a problem hiding this comment.
I think if we were to capture anything it would be that the license is in compliance with NASA open-source software requirements. Potential text:
LICENSE- Required for distribution under NASA open-source approval. Details conditions for use, reproduction and distribution.
Probably not perfect text, but I think that's the gist of anything I would add.
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 |
| |- docker | ||
| |- docs | ||
| |- harmony_browse_image_generator | ||
| |- legacy-CHANGELOG.md |
There was a problem hiding this comment.
I think if we were to capture anything it would be that the license is in compliance with NASA open-source software requirements. Potential text:
LICENSE- Required for distribution under NASA open-source approval. Details conditions for use, reproduction and distribution.
Probably not perfect text, but I think that's the gist of anything I would add.
Also: Adds license text to readme. Reorders file descriptions correctly.
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.txtRun 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
CHANGELOG.mdupdated to include high level summary of PR changes.docker/service_version.txtupdated if publishing a release.No release needed since this is only documentation related.