Skip to content

Latest commit

 

History

History
83 lines (56 loc) · 3.5 KB

README.md

File metadata and controls

83 lines (56 loc) · 3.5 KB

EASI Notebooks

Jupyter notebooks for learning and advancing your use of EASI, https://research.csiro.au/easi.

  • Use the examples in these notebooks to build your own data analysis and applications.
  • These notebooks have been adapted and written for CSIRO's EASI deployments.

These notebooks build on and contribute to the Open Data Cube, CEOS and cloud-based EO analytics communities (Acknowledgment and Credit).

Lake Tempe, Indonesia. Landsat-8 (2020-03-13) RGB

Overview

notebooks/

  • Notebooks that introduce aspects of EASI, Dask and the Open Data Cube libraries.
  • Work through these as a Training exercise, and refer back to them for examples.

notebooks/data_products/

  • Examples for accessing and using EASI data products.
  • Adapt or copy from these for your own work.

html/

  • HTML version of each notebook for easy web browsing.

easi_tools/

  • Helper scripts used in the these notebooks.

resources/

  • Supplementary files and images used in the EASI notebooks.

bin/

  • Scripts for managing and contributing to the repository.

Contributing

Contributions are welcome.

A pre-commit hook is provided in /bin. For each notebook committed this will:

  1. Create an HTML copy of the notebook into html/.
  2. Strip outputs from the notebook to reduce the size of the repository.

The apply_hooks.sh script creates a symlink to bin/pre-commit.

# Run this in your local repository
sh bin/apply_hooks.sh

For contributors:

  1. Apply the pre-commit hook.
  2. Run each notebook (that has been updated) to populate the figures, tables and other outputs as you want them.
  3. Add a link into html/readme.md for each new notebook.
  4. Add an item to whats_new.md.
  5. git add and git commit.
  6. If everything looks ok, git push to your branch/fork of this repository and create a pull request.

Acknowledgment and Credit

Many of the notebooks and code have been built on top of and with a range of community contributions, learnings and experience. Most notebooks will provide acknowledgments or references where appropriate. Please add an issue or PR if you identify a contribution that you would like to see acknowledged appropriately. We acknowledge broad based contributions from the community:

License

Apache License 2.0, https://www.apache.org/licenses/LICENSE-2.0.