Migrate nsidc data tutorials content #70
Conversation
This distinguishes these notebooks from the iceflow library
Also move icepyx higher in the list
From nsidc/NSIDC-Data-Tutorials#80. See related issue: #69
* Stop splitting notebooks into those that are rendered and those that are not. It requires remembering to render the notebooks for the docs separately. Now the docs notebooks are just symlinks to the notebooks in the `notebooks/` dir. * Update text/language around notebooks, and nest all notebooks under one section in the docs
Sphinx/myst_nb seems to have problems with including the extension. I get xref missing warnings when they are present. It also causes relative links with `.ipynb` to not render at all in the docs. This represents a trade-off: the docs will have nicely rendered links to the other notebooks. For users who download the files themselves and execute them as notebooks locally, the links will not work. However, it should be clear enough what they refer to.
* Remove bolding of some headings. This is more consistent with the other notebooks * Increase heading level of subheadings. Keep only top-level title as h1. This makes navigation in the doc TOC a little cleaner.
Confusing to have the same text hyperlinked to two separate locations.
The headings markdown itself (`#`) and the order content is presented already provides structure without needing to add and maintain numbered headings. This is consistent with the other iceflow notebooks.
|
Thought: the |
* Move challenges about data use to after overview of missions. * Include references to other companion notebooks.
|
TODO: once we settle on titles of notebooks and if the intro notebook should remain as a notebook, rename to correspond wtih their titles. E.g., |
Eliminates confusion around notebooks "living" in two separate locations. Although the symlinks did work, it was still a bit confusing. Importantly, clicking on the "view this page" link at the top that takes the user to GitHub directs users to the symlink, which might be confusing. Users should be able to click on that button to directly go to and download the notebook and run it themselves. This also makes it clearer that the notebooks are part of the documentation. It still may be worth considering letting `myst_nb` execute the notebooks at build time, but I worry about very long execution times for the icepyx notebook in particular. It might be better to have the developer execute the cells manually. Also, it would require our CI pipeline to have earthdata login creds to download the necessary data.
trey-stafford
force-pushed
the
69-migrate-nsidc-data-tutorials-content
branch
from
4e84333 to
5eac08e
Compare
Migrated to the `iceflow` standalone repository in nsidc/iceflow#70
Co-authored-by: Amy Steiker <[email protected]>
I had the same thought. I don't see any reason not to convert to markdown. I would also suggest updated the title to be consistent with the others. It could be renamed to something lke
Yes the logo can be removed. I agree it's a bit funny to have it appear in this notebook but not the others.
I don't think this is critical but certainly couldn't hurt. It could be as simple as mentioning that there are several tutorial notebooks located in the /docs/notebooks folder that can be executed locally, and these same notebooks can be viewed via the documentation site: https://iceflow.readthedocs.io/en/latest/.
Agreed! Though these don't necessarily need to be 1:1. Let me know what you have in mind. |
There was a problem hiding this comment.
@trey-stafford I also received an error when running this notebook at the following line:
downloaded_files = download_iceflow_results(search_results, output_dir=OUTPUT_DIR)
PermissionError: User: arn:aws:sts::695478930278:assumed-role[/s3-same-region-access-role/amy.steiker](https://openscapes.2i2c.cloud/s3-same-region-access-role/amy.steiker) is not authorized to perform: s3:ListBucket on resource: "arn:aws:s3:::nsidc-cumulus-prod-protected" with an explicit deny in a resource-based policy
There was a problem hiding this comment.
Hmm, are you running this locally? Or in a cloud environment?
I suspect this is might have been a temporary problem with EDL. Would you be willing to re-try and confirm if this problem persists? I just re-ran this notebook after deleting the downloaded-data/ folder to ensure that the data were re-downloaded, and it succeeded.
There was a problem hiding this comment.
We attempted to troubleshoot this and determined it is likely an EDL issue on my end, not anything to do with the library. So let's move forward with the merge and we can continue to investigate where this issue is stemming from.
Top-level website displays logo
trey-stafford
force-pushed
the
69-migrate-nsidc-data-tutorials-content
branch
from
f0d59ea to
06af3e5
Compare
Removed in 06af3e5 |
Easier to maintain this as markdown than a jupyter notebook, esp. since it's just markdown!
Implemented in 636349a . I named the markdown file |
Resolves #69 and addresses feedback in nsidc/NSIDC-Data-Tutorials#80
Doc preview can be seen here: https://iceflow--70.org.readthedocs.build/en/70/
Juptyter notebooks have been placed into their own section, "Jupyter Notebooks": https://iceflow--70.org.readthedocs.build/en/70/notebooks/index.html