-
Notifications
You must be signed in to change notification settings - Fork 26
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
Add cog access via python doc #124
base: staging
Are you sure you want to change the base?
Add cog access via python doc #124
Conversation
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
545212b
to
1913d46
Compare
@smk0033 and @hrodmn might want to review Sadly ReviewNB didn't want to save my comments (ah because of the force push while I was working), here they are in order but out of context without the section references. I think Key Benefits should be moved to https://guide.cloudnativegeo.org/cloud-optimized-geotiffs/intro.html The other existing pages should also be referenced where applicable. In our other examples we provide a conda env with the packages https://guide.cloudnativegeo.org/cloud-optimized-geotiffs/cogs-examples.html I think we need a TLDR code block first, this with the shortest example possible, and a read on if you want to know more. We want to get across that it's actually very simple to use. "we can a free," incomplete statement Should we link to a page about Sentinel-2, either official home page or Wikipedia, what about citing the OpenData page on AWS too? I think it's better to say we're going to align our request with the internal tile structure to prove how requests are partial and minimized. In normal usage a user would not usually think about this at all. Consider reordering the title of this section to de-emphasize visualization since the next section is actually about data visualization. "Internal Tile Grid of the COG" seems ok on it's own, or maybe "Understanding the ..." maybe use rio info or gdalinfo, or rasterio properties to show the overview levels and their resolutions? |
View / edit / reply to this conversation on ReviewNB hrodmn commented on 2025-01-24T17:01:37Z Following on @wildintellect's suggestion for some quick code examples at the top I think it would be valuable to include a quick example for how to determine if a file is a COG or not and also an example of how to write a COG since it is really important for users who are creating data to produce COGs, too. wildintellect commented on 2025-01-24T17:25:25Z @hrodmn that is already covered in a different doc https://guide.cloudnativegeo.org/cloud-optimized-geotiffs/writing-cogs-in-python.html and https://guide.cloudnativegeo.org/cloud-optimized-geotiffs/cogs-examples.html#is-it-a-valid-cog
We should be linking to those. |
View / edit / reply to this conversation on ReviewNB hrodmn commented on 2025-01-24T17:01:38Z
|
This is a great, thanks @moradology! I think the only things I would add are 1) how to find out if a .tif file is a COG and 2) how to write a COG with rasterio (or |
@hrodmn that is already covered in a different doc https://guide.cloudnativegeo.org/cloud-optimized-geotiffs/writing-cogs-in-python.html and https://guide.cloudnativegeo.org/cloud-optimized-geotiffs/cogs-examples.html#is-it-a-valid-cog
We should be linking to those. View entire conversation on ReviewNB |
1913d46
to
41096cb
Compare
View / edit / reply to this conversation on ReviewNB smk0033 commented on 2025-01-29T21:26:51Z The "guide on writing COGs" and "guide on COG validation" hyperlinks lead to 404 errors (not sure if you can just link back to the .ipynb versions, or if the current paths will work when the notebook is published and in the docs? If the latter is true, then you can ignore this comment!) |
I really like the detail and explanations in this notebook! I had one minor comment about a couple broken hyperlinks, but those may work when the notebook is published and in the docs |
We can check the links in a preview when the PR is opened from staging to main |
This PR adds some documentation about accessing data within cogs without loading the whole file. It included rasterio and rio-xarray examples and provides (slightly annoying, hacky) logging of byte-ranges requested to reveal some of the goings-on behind the curtain