Update quickstart tutorial #674
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@KennSmithDS It would be good to get your feedback on whether this clarifies some of the issues that you ran into when getting started. |
Codecov Report
@@ Coverage Diff @@
## main #674 +/- ##
=======================================
Coverage 94.20% 94.20%
=======================================
Files 77 77
Lines 11120 11120
Branches 1082 1082
=======================================
Hits 10476 10476
Misses 466 466
Partials 178 178 Continue to review full report at Codecov.
|
duckontheweb
added a commit
to duckontheweb/pystac
that referenced
this pull request
Nov 29, 2021
lossyrob
approved these changes
Dec 6, 2021
docs/quickstart.ipynb
Outdated
| "item = next(local_root_2.get_all_items())\n", | ||
| "item.bbox = ['Not a valid bbox']\n", | ||
| "item.validate()" | ||
| "shutil.rmtree(tmp_dir)" |
There was a problem hiding this comment.
Should use the ignore_errors=True to avoid error output
docs/quickstart.ipynb
Outdated
| "\n", | ||
| "[A STAC Catalog](https://github.com/radiantearth/stac-spec/tree/master/catalog-spec) is used to group other STAC objects like Items, Collections, or even other Catalogs.\n", | ||
| "\n", | ||
| "We will be using a small example catalog adapted from the `geotrellis` [example Landsat Collection](https://github.com/geotrellis/geotrellis-server/tree/977bad7a64c409341479c281c8c72222008861fd/stac-example/catalog/landsat-stac-collection). All STAC Items and Collections can be found in the [docs/example-catalog](./example-catalog) directory of this repo; all Assets are hosted in the Landsat S3 bucket.\n", |
There was a problem hiding this comment.
Should capitalize project name GeoTrellis. Also perhaps link to project homepage (https://geotrellis.io/)
docs/quickstart.ipynb
Outdated
| "\n", | ||
| "[STAC Collections](https://github.com/radiantearth/stac-spec/tree/master/collection-spec) are used to group related Items and provide aggregate or summary metadata for those Items.\n", | ||
| "\n", | ||
| "STAC Catalogs may have many nested layers of Catalogs or Collections within the top-level collection. Our example catalog has one Collection within the main Catalog at ([landsat-8-l1/collection.json](./example-catalog/landsat-8-l1/collection.json). We can list the Collections in a given Catalog using the [`Catalog.get_collections`](https://pystac.readthedocs.io/en/latest/api.html#pystac.Catalog.get_collections) method. This method returns an iterable of PySTAC [`Collection`](https://pystac.readthedocs.io/en/latest/api.html#collection) instances, which we will turn into a `list`." |
There was a problem hiding this comment.
2 things:
- There's a stray open paren in the first landsat link that throws off rendering.
- The nbsphinx can't handle backticks in the brackets for links (seen when rendering the quickstart through
make livehtmlin the docs folder). You should remove backticks, e.g. [`Catalog.get_collections`] ->[Catalog.get_collections]
matthewhanson
approved these changes
Dec 6, 2021
duckontheweb
force-pushed
the
update/665-462-606-quickstart
branch
from
f058c1b to
a5f0a9c
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related Issue(s):
Description:
This PR updates the Quickstart tutorial notebook to be up-to-date with the current version of PySTAC (v1.2.0). It also uses an example catalog that is included in the repository instead of depending on an external catalog. This will help make the tutorial more self-contained, and should make it easier to ensure that the example we are using is in sync with the STAC spec version that PySTAC currently supports.
PR Checklist:
pre-commit run --all-files)scripts/test)