NASA-Openscapes / earthdata-cloud-cookbook

A tutorial book of workflows for research using NASA EarthData in the Cloud created by the NASA-Openscapes team
https://nasa-openscapes.github.io/earthdata-cloud-cookbook
Other
87 stars 32 forks source link

Add pygeoweaver demo of how to reuse FAIRable workflows #214

Closed ZihengSun closed 1 year ago

ZihengSun commented 1 year ago

What is in this PR?

Based on the amazing tutorials introduced by Amy, we converted the steps of the tutorials into a FAIRable workflow, and this notebook will show how to download the workflow, browse details of the workflow, and edit the process code, and re-run the workflow and check history.

FAIRable workflow is the key to enhance our productivity as a community, especially for use cases like Earth AI which is full of uncertainties and RRR (reproducibility, replicability, and reusability) challenges. We must adopt tools to help us ensure the bottomline that our work (everyone's time and efforts) is sharable and continuable by other colleges, and no work is wasted on reinventing wheels, or duplicating previous experiments, or solving the issues that have already been solved many times by others.

References

As we discussed about the documentation, we did use help from AI to create some good documentation: https://gokulprathin8.github.io/pygeoweaver-docs.github.io/docs/getting-started (this is the temp link and we will move it to a permanent link soon). Any suggestions would be welcome!

jules32 commented 1 year ago

This is super Ziheng, thank you for contributing! 🎉 Great that you've shared it here as a draft review; the Mentors will review when you finalize the PR and we'll get this in the Cookbook!

ZihengSun commented 1 year ago

hello @jules32 this should be ready for testing and review, anything please let us know :)

stefaniebutland commented 1 year ago

Hi @ZihengSun! Thank you for this pull request. I'll arrange with one of the Mentors to test, review, and merge

ZihengSun commented 1 year ago

Hi @ZihengSun! Thank you for this pull request. I'll arrange with one of the Mentors to test, review, and merge

Thanks @stefaniebutland ! Yeah, let us know if any requested changes :) Have a happy weekend!

stefaniebutland commented 1 year ago

Hi @ZihengSun, I looked at this with @battistowx. To have this included in the Cookbook, please edit _quarto.yml file to add the following in the tutorials section. text is what you want the title to be.

          - href: tutorials/fair-workflow-geoweaver-demo.ipynb
            text: "pygeoweaver demo"

so that it will show up in Tutorials section as below.

      - section: tutorials/index.qmd
        contents:
          - href: external/How_to_Perform_Cross-DAAC_S3_Bucket_Access_Using_Python.ipynb
            text: "Multi-datasets 1"
          - href: external/IS2_cloud_Landsat_integration.ipynb
            text: "Multi-datasets 2"
          - href: external/Sea_level_rise_notebook.ipynb
            text: "Sea Level Rise: `earthaccess`"
          - href: tutorials/04_On-Prem_Cloud.ipynb
            text: "Cloud & Non-cloud"
          - href: examples/Earthdata-cloud-clinic.ipynb
            text: "Earthdata Cloud Clinic"
          - href: tutorials/earthaccess-demo.ipynb
            text: "`earthaccess` Python library"
          - href: tutorials/fair-workflow-geoweaver-demo.ipynb
            text: "pygeoweaver demo"

We can merge the pull request once you've pushed that edit.

stefaniebutland commented 1 year ago

@ZihengSun Please check that it appears as you expect: https://nasa-openscapes.github.io/earthdata-cloud-cookbook/tutorials/fair-workflow-geoweaver-demo.html

Thank you again and thanks to @battistowx for reviewing. This is helping us figure out how to improve our Contributing documentation too!

ZihengSun commented 1 year ago

@ZihengSun Please check that it appears as you expect: https://nasa-openscapes.github.io/earthdata-cloud-cookbook/tutorials/fair-workflow-geoweaver-demo.html

Looks great! Thanks a lot @stefaniebutland

Thank you again and thanks to @battistowx for reviewing. This is helping us figure out how to improve our Contributing documentation too!

Thanks @battistowx for reviewing the PR! And will do :) Happy weekend all!