A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

Digital Earth Africa Notebooks

Using Earth observations to address social, environmental and economic changes on the Africa continent.
https://github.com/digitalearthafrica/deafrica-sandbox-notebooks

Category: Sustainable Development
Sub Category: Data Catalogs and Interfaces

Keywords

earthobservation hacktoberfest jupyter-notebooks opendatacube python remotesensing xarray

Keywords from Contributors

geospatial-data sentinel-2 digitalearthaustralia earth-observation geoscienceaustralia gdal ogc-services geophysics trace control

Last synced: about 11 hours ago
JSON representation

Repository metadata

Repository for Digital Earth Africa Sandbox, including: Jupyter notebooks, scripts, tools and workflows for geospatial analysis with Open Data Cube and xarray

README.md

Digital Earth Africa Notebooks

License: The code in this repository is licensed under the Apache License, Version 2.0. Digital Earth Africa data is licensed under the Creative Commons by Attribution 4.0 license.

Contact: If you need assistance with any of the Jupyter Notebooks or Python code in this repository, please post a question on the Open Data Cube Slack channel or on the GIS Stack Exchange using the open-data-cube tag (you can view previously asked questions here. If you would like to report an issue with any of the scripts or notebooks in this repository, you can file one on the Github issues page.

Citing DE Africa Notebooks: If you use any of the notebooks, code or tools in this repository in your work, please reference them using 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

The Digital Earth Africa Notebooks repository (deafrica-sandbox-notebooks) hosts Jupyter Notebooks, Python scripts and workflows for analysing Digital Earth Africa (DE Africa) satellite data and derived products. This documentation is designed to provide a guide to getting started with DE Africa, and to showcase the wide range of geospatial analyses that can be achieved using DE Africa data and open-source software including Open Data Cube and xarray.

The repository is based around the following directory structure (from simple to increasingly complex applications):

  1. Beginners_guide: Introductory notebooks aimed at introducing Jupyter Notebooks and how to load, plot and interact with DE Africa data.

  2. Datasets: Notebooks introducing DE Africa's satellite datasets and derived products, including how to load each dataset and any special features of the data. Some external datasets that are useful for analysing and interpreting DE Africa products are also covered.

  3. Frequently_used_code: A recipe book of simple code examples demonstrating how to perform common geospatial analysis tasks using DE Africa and open-source software.

  4. Real_world_examples: More complex workflows demonstrating how DE Africa can be used to address real-world problems.

  5. Use Cases: Notebooks in this collection are developed for specific use-cases of the Digital Earth Africa platform and may not run as seamlessly as notebooks in the other folders of this repository. Notebooks may contain less descriptive markdown, contain more complicated or bespoke analysis, and may take a long time to run. However, they contain useful analysis procedures and provide further examples for advanced users.

The supporting scripts and data for the notebooks are kept in the following directories:

  • Tools: Python functions and algorithms developed to assist in analysing DE Africa data (e.g. loading data, plotting, spatial analysis, machine learning).

  • Supplementary_data: Supplementary files required for the analyses above (e.g. images, rasters, shapefiles, training data).


Getting started with DE Africa Notebooks

To get started with using deafrica-sandbox-notebooks, visit
the DE Africa Notebooks Wiki page. This page includes guides for getting started on the DE Africa Sandbox.

Once you're set up, the main option for interacting with deafrica-sandbox-notebooks and contributing back to the repository is through:

  • DE Africa notebooks using Git: Git is a version-control software designed to help track changes to files and collaborate with multiple users on a project. Using git is the recommended workflow for working with deafrica-sandbox-notebooks as it makes it easy to stay up to date with the latest versions of functions and code, and makes it impossible to lose your work.

  • Set up Git authentication tokens: Git requires multi-factor authentication when using the command line or API. Set up a personal access token by following instructions from the GitHub Docs.


Contributing to DE Africa Notebooks

Main and working branches

The deafrica-sandbox-notebooks repository uses 'branches' to manage individuals' notebooks, and to allow easy publishing of notebooks ready to be shared. There are two main types of branches:

  • Main branch: The main branch contains DE Africa's collection of publicly available notebooks. The main branch is protected, and is only updated after new commits a reviewed and approved by the DE Africa team.
  • Working branches: All other branches in the repository are working spaces for users of deafrica-sandbox-notebooks. They have a unique name (typically named after the user). The notebooks on these branches can be works-in-progress and do not need to be pretty or complete. By using a working branch, it is easy to use scripts and algorithms from deafrica-sandbox-notebooks in your own work, or share and collaborate on a working version of a notebook or code.

Publishing notebooks to the main branch

Once you have a notebook that is ready to be published on the main branch, you can submit a 'pull request' in the Pull requests tab at the top of the repository. The default pull request template contains a check-list to ensure that all main branch Jupyter notebooks are consistent and well-documented so they can be understood by future users, and rendered correctly. Please ensure that as many of these checklist items are complete as possible, or leave a comment in the pull request asking for help with any remaining checklist items.

Draft pull requests

For pull requests you would like help with or that are a work in progress, consider using Github's draft pull request feature. This indicates that your work is still a draft, allowing you to get feedback from other DE Africa users before it is published on the main branch.


DE Africa Notebooks template notebook

A template notebook has been developed to make it easier to create new notebooks that meet all the pull request checklist requirements. The template notebook contains a simple structure and useful general advice on writing and formatting Jupyter notebooks. The template can be found here: DEAfrica_notebooks_template.ipynb

Using the template is not required for working branch notebooks, but is highly recommended as it will make it much easier to publish any notebooks on main in the future.


Approving pull requests

Anyone with admin access to the deafrica-sandbox-notebooks repository can approve 'pull requests'.

If the notebook meets all the checklist requirements, click the green 'Review' button and click 'Approve' (with an optional comment). You can also 'Request changes' here if any of the checklist items are not complete.

Once the pull request has been approved, you can merge it into the main branch. Select the 'Squash and merge' option from the drop down menu to the right of the green 'merge' button. Once you have merged the new branch in, you need to delete the branch. There is a button on the page that asks you if you would like to delete the now merged branch. Select 'Yes' to delete it.


Update: The default branch has been renamed!

October 2021

master is now named main in line with GitHub recommended naming conventions.

If you have a local clone created before 29 October 2021, you can update it by running the following commands.

git branch -m master main
git fetch origin
git branch -u origin/main main
git remote set-head origin -a

Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 6 days ago

Total Commits: 1,286
Total Committers: 42
Avg Commits per committer: 30.619
Development Distribution Score (DDS): 0.81

Commits in past year: 140
Committers in past year: 8
Avg Commits per committer in past year: 17.5
Development Distribution Score (DDS) in past year: 0.529

Name Email Commits
cbur24 c****3@g****m 244
vikineema v****a@k****m 237
nanaboamah89 n****9@g****m 193
Michael Wellington m****n@a****u 129
mpho-sadiki m****i@d****g 73
eefaye e****g@g****m 54
caitlinadams c****s@g****m 48
NMoghaddam n****m@g****u 44
lavender-liu l****u@f****u 37
Fang Yuan f****n@d****g 33
NMoghaddam n****m@a****u 25
Fang Yuan f****n@g****u 25
Andrew Hicks a****s@f****u 19
Robbi Bishop-Taylor R****r@g****u 18
lewistrotter 5****r 12
Fang Yuan f****y 11
Cate Kooymans c****s@g****u 11
Alex Leith a****h@g****m 8
John Rattz j****z@a****m 8
jinjun sun j****n@g****u 8
eloise-b e****l@g****m 7
Duncan Gray d****y@g****u 7
Nikita n****i@g****m 4
Imam Alam u****h 3
Nikhil Garg n****u@g****m 3
Alex Leith a****b@g****m 2
mickwelli m****n@d****g 2
abradley60 a****0@g****m 2
github-actions g****s@g****m 2
jdh-ama 5****a 2
and 12 more...

Committer domains:


Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 88
Total pull requests: 509
Average time to close issues: about 2 months
Average time to close pull requests: 14 days
Total issue authors: 20
Total pull request authors: 38
Average comments per issue: 1.28
Average comments per pull request: 0.76
Merged pull request: 430
Bot issues: 0
Bot pull requests: 1

Past year issues: 6
Past year pull requests: 86
Past year average time to close issues: N/A
Past year average time to close pull requests: 7 days
Past year issue authors: 2
Past year pull request authors: 8
Past year average comments per issue: 0.0
Past year average comments per pull request: 0.55
Past year merged pull request: 68
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/digitalearthafrica/deafrica-sandbox-notebooks

Top Issue Authors

  • mubea (15)
  • cbur24 (14)
  • lisarebelo (11)
  • nanaboamah89 (10)
  • fangfy (8)
  • eefaye (7)
  • vikineema (5)
  • caitlinadams (4)
  • alexgleith (2)
  • andrewdhicks (2)
  • fedebotu (1)
  • jaunvl-github (1)
  • gumpgourou (1)
  • erialC-P (1)
  • tylere (1)

Top Pull Request Authors

  • cbur24 (114)
  • nanaboamah89 (81)
  • vikineema (63)
  • mickwelli (38)
  • mpho-sadiki (36)
  • fangfy (27)
  • caitlinadams (25)
  • andrewdhicks (19)
  • eefaye (15)
  • NMoghaddam (14)
  • lewistrotter (13)
  • BexDunn (10)
  • robbibt (6)
  • alexgleith (4)
  • NikitaGandhi (4)

Top Issue Labels

  • enhancement (4)

Top Pull Request Labels

  • hacktoberfest-accepted (6)
  • enhancement (5)
  • bug (3)
  • documentation (1)
  • dependencies (1)

Package metadata

pypi.org: deafrica-tools

Functions and algorithms for analysing Digital Earth Africa data.

  • Homepage: https://github.com/digitalearthafrica/deafrica-sandbox-notebooks
  • Documentation: https://docs.digitalearthafrica.org/en/latest/sandbox/notebooks/Tools/index.html
  • Licenses: Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
  • Latest release: 2.5.7 (published 3 months ago)
  • Last Synced: 2025-04-25T14:37:02.733Z (1 day ago)
  • Versions: 48
  • Dependent Packages: 0
  • Dependent Repositories: 3
  • Downloads: 2,132 Last month
  • Rankings:
    • Forks count: 4.322%
    • Downloads: 5.858%
    • Stargazers count: 6.029%
    • Average: 6.532%
    • Dependent packages count: 7.31%
    • Dependent repos count: 9.143%
  • Maintainers (2)

Score: 16.78010628128668