Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Edited the repo's README #1193

Merged
merged 29 commits into from
Feb 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
b6e864c
Migrated Git workflow out of README and fixed one link
benjamin-glitsos Feb 26, 2024
0a5f1eb
Converted README format from .rst to .md
benjamin-glitsos Feb 26, 2024
6b76d42
Added contribute anchor link
benjamin-glitsos Feb 26, 2024
c4f0c0f
Added more spacing
benjamin-glitsos Feb 26, 2024
6cc4ff0
Adjusting spacing
benjamin-glitsos Feb 26, 2024
9c062a6
Formatting using em-dashes
benjamin-glitsos Feb 26, 2024
a62a8ae
Minor edits
benjamin-glitsos Feb 26, 2024
6c765fb
Editing the README
benjamin-glitsos Feb 26, 2024
bc89acf
Reworded introduction intro
benjamin-glitsos Feb 26, 2024
6b5f347
Editing Introduction section
benjamin-glitsos Feb 26, 2024
48fd125
Updating to use KH links
benjamin-glitsos Feb 26, 2024
9bfb566
Editing README further
benjamin-glitsos Feb 26, 2024
70f4ce4
Wrote separate section for the sandbox
benjamin-glitsos Feb 26, 2024
550c258
Added DEA Sandbox image
benjamin-glitsos Feb 26, 2024
c0d11b8
Styling the image
benjamin-glitsos Feb 26, 2024
8ff2ad8
Moved the image
benjamin-glitsos Feb 26, 2024
fb6e24f
Grammarly check
benjamin-glitsos Feb 26, 2024
1caa945
Review of draft
benjamin-glitsos Feb 26, 2024
d21994f
Updated directory descriptions to match the Sandbox's new cover page
benjamin-glitsos Feb 26, 2024
d3d9e1c
Moved the introduction paragraph lower into its own section
benjamin-glitsos Feb 26, 2024
7b561ca
Added NCI content
benjamin-glitsos Feb 26, 2024
9edbcf0
Added NCI content
benjamin-glitsos Feb 26, 2024
a9f01df
Removed accidental link
benjamin-glitsos Feb 26, 2024
eeb9073
Updating NCI and Sandbox links
benjamin-glitsos Feb 26, 2024
cbaa365
Commented out the tags paragraph
benjamin-glitsos Feb 26, 2024
54c74c0
Moving the Knowledge Hub section
benjamin-glitsos Feb 26, 2024
85f1d67
Moving KH section back up
benjamin-glitsos Feb 26, 2024
8739828
Minor wording
benjamin-glitsos Feb 27, 2024
76508b2
Minor formatting
benjamin-glitsos Feb 27, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 102 additions & 0 deletions README.md
benji-glitsos-ga marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -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). -->

125 changes: 0 additions & 125 deletions README.rst

This file was deleted.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading