Merge pull request #1195 from GeoscienceAustralia/develop

Merge develop to stable

README.md

@@ -0,0 +1,102 @@
+<img src="Supplementary_data/dea_logo_wide.jpg" width="900" alt="Digital Earth Australia logo" />
+
+# DEA Notebooks
+
+[![DOI](https://img.shields.io/badge/DOI-10.26186/145234-0e7fbf.svg)](https://doi.org/10.26186/145234) [![Apache license](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![PyPI](https://img.shields.io/pypi/v/dea-tools)](https://pypi.org/project/dea-tools/) [![Notebook testing](https://github.com/GeoscienceAustralia/dea-notebooks/actions/workflows/test_notebooks.yml/badge.svg?branch=develop)](https://github.com/GeoscienceAustralia/dea-notebooks/actions/workflows/test_notebooks.yml)
+
+<br />
+
+This is the DEA Notebooks and DEA Tools repository of [Digital Earth Australia](https://www.dea.ga.gov.au/).
+These can be viewed on the [DEA Knowledge Hub](https://docs.dea.ga.gov.au/) or
+run on the [DEA Sandbox](https://docs.dea.ga.gov.au/guides/setup/Sandbox/sandbox/)
+or the [National Computational Infrastructure (NCI)](https://docs.dea.ga.gov.au/guides/setup/NCI/README/).
+
+**Contribute** &mdash; DEA Notebooks is open-source and we would love your contribution!
+Learn [how to contribute](#contribute) below.
+
+**License** &mdash; The code in this repository is licensed under the [Apache
+License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0). DEA
+data is licensed under the [Creative Commons by Attribution 4.0
+license](https://creativecommons.org/licenses/by/4.0/).
+
+**Documentation** &mdash; See the [DEA Notebooks
+Wiki](https://github.com/GeoscienceAustralia/dea-notebooks/wiki).
+
+**Contact** &mdash; For assistance with any of these notebooks and tools,
+please ask a question on our [Open Data Cube Slack
+channel](http://slack.opendatacube.org/) or on the [GIS Stack
+Exchange](https://gis.stackexchange.com/questions/tagged/open-data-cube)
+using the `open-data-cube` tag. You can also [report an issue on this
+repository](https://github.com/GeoscienceAustralia/dea-notebooks/issues).
+
+**Citation** &mdash; If you use this repository in your work, please reference
+it with the following citation.
+
+> Krause, C., Dunn, B., Bishop-Taylor, R., Adams, C., Burton, C., Alger,
+> M., Chua, S., Phillips, C., Newey, V., Kouzoubov, K., Leith, A.,
+> Ayers, D., Hicks, A., DEA Notebooks contributors 2021. Digital Earth
+> Australia notebooks and tools repository. Geoscience Australia,
+> Canberra. <https://doi.org/10.26186/145234>
+
+## Introduction
+
+The Jupyter Notebooks and Python tools in this repository are for
+analysing DEA's satellite data products. The notebooks are designed to demonstrate
+how to use the DEA data and tools to conduct a broad range of geospatial
+analyses. They also demonstrate how to integrate with other open-source
+software such as [Open Data Cube](https://www.opendatacube.org/) and
+[xarray](http://xarray.pydata.org/en/stable/). You can see examples of
+use cases on the [USAGE](https://github.com/GeoscienceAustralia/dea-notebooks/blob/stable/USAGE.rst)
+page.
+
+## View on the DEA Knowledge Hub
+
+The **DEA Knowledge Hub** is where you can easily view the notebooks and read DEA Tools documentation. You can browse the following sections.
+
+* **[Beginner’s guide](https://docs.dea.ga.gov.au/notebooks/Beginners_guide/)** &mdash;
+  Introductory notebooks aimed at introducing Jupyter Notebooks and how to load,
+  plot, and interact with DEA data.
+* **[DEA products](https://docs.dea.ga.gov.au/notebooks/DEA_products/)** &mdash;
+  Notebooks introducing DEA's satellite datasets and derived products,
+  including how to load each dataset and any special features of the data.
+* **[How-to guides](https://docs.dea.ga.gov.au/notebooks/How_to_guides/)** &mdash;
+  A recipe book of simple code examples demonstrating how to perform common
+  geospatial analysis tasks using DEA and open-source software.
+* **[Interactive apps](https://docs.dea.ga.gov.au/notebooks/Interactive_apps/)** &mdash;
+  Interactive apps and widgets that require little or no coding to run.
+* **[Real-world examples](https://docs.dea.ga.gov.au/notebooks/Real_world_examples/)** &mdash;
+  More complex case study workflows demonstrating how DEA can be
+  used to address real-world problems.
+* **[DEA Tools Package](https://docs.dea.ga.gov.au/notebooks/Tools/)** &mdash;
+  An open-source Python package containing functions and
+  algorithms to assist in analysing DEA data.
+
+## Run on the DEA Sandbox
+
+The **DEA Sandbox** is a free virtual environment for interacting with the notebooks and tools from your web browser. You can use the Sandbox to conduct geospatial analysis without installing anything on your computer. Learn how to [use the DEA Sandbox](https://docs.dea.ga.gov.au/guides/setup/Sandbox/sandbox/).
+
+<a href="https://app.sandbox.dea.ga.gov.au/"><img src="Supplementary_data/DEA_Sandbox/DEA_Sandbox_cover_page.png" width="500" alt="The cover page of the DEA Sandbox." /></a>
+
+## Run on the NCI
+
+The **National Computational Infrastructure** is a supercomputer environment available to Australian researchers, academics, and other users by negotiation. The NCI can be used for high-performance geospatial analysis. Learn how to [use the NCI](https://docs.dea.ga.gov.au/guides/setup/NCI/README/).
+
+<span id="contribute"></span>
+
+## How to contribute
+
+To get started, see these articles in the wiki.
+
+* [Git workflow](https://github.com/GeoscienceAustralia/dea-notebooks/wiki/Git-workflow)
+* [Create a DEA Notebook](https://github.com/GeoscienceAustralia/dea-notebooks/wiki/Create-a-DEA-Notebook)
+* [Edit a DEA Notebook](https://github.com/GeoscienceAustralia/dea-notebooks/wiki/Edit-a-DEA-Notebook)
+
+We would also appreciate it if you could add your a citation to our
+[USAGE](https://github.com/GeoscienceAustralia/dea-notebooks/blob/stable/USAGE.rst)
+page.
+
+<!-- All notebooks in this repository contain tags describing -->
+<!-- their functionality. If you are searching for a specific functionality, use the [Tags Index](https://github.com/GeoscienceAustralia/dea-notebooks/blob/develop/genindex) to search for a suitable example. If there is an important functionality that has not been -->
+<!-- documented, please [report an issue on this -->
+<!-- repository](https://github.com/GeoscienceAustralia/dea-notebooks/issues). -->
+

Tools/index.rst

@@ -1,10 +1,9 @@
 DEA Tools Package
-=======================
+=================
 
-``dea_tools`` is a Python package contains several modules with functions to load, analyse
-and output data from Digital Earth Australia. It is automatically installed in the Digital Earth 
-Australia Sandbox environment. More information on installing this package can be found on the `Tools
-<https://github.com/GeoscienceAustralia/dea-notebooks/tree/develop/Tools/>`_ section of the GitHub repository.
+``dea_tools`` is a Python package containing various functions to load, analyse, and output data from Digital Earth Australia.
+
+This package is installed by default in the DEA Sandbox. You can install it to your own environment from `PyPi <https://pypi.org/project/dea-tools/>`_ by running ``pip install dea-tools``. Learn more in the `DEA Tools Readme <https://github.com/GeoscienceAustralia/dea-notebooks/tree/develop/Tools/>`_.
 
 Core modules
 ------------
@@ -49,6 +48,7 @@ Apps and widgets
 
 License
 -------
+
 The code in this module is licensed under the Apache License,
 Version 2.0 (https://www.apache.org/licenses/LICENSE-2.0).
 
@@ -57,6 +57,7 @@ Attribution 4.0 license (https://creativecommons.org/licenses/by/4.0/).
 
 Contact
 -------
+
 If you need assistance, please post a question on the Open Data
 Cube Slack channel (http://slack.opendatacube.org/) or on the GIS Stack
 Exchange (https://gis.stackexchange.com/questions/ask?tags=open-data-cube)