Giter Club home page Giter Club logo

dea-knowledge-hub's Introduction

dea-knowledge-hub's People

Contributors

benji-glitsos-ga avatar cekrause avatar robbibt avatar omad avatar gypsybojangles avatar andrewdhicks avatar ohehir-aaron avatar laurenschenk1 avatar caitlinadams avatar stevesagar avatar treefern avatar kirill888 avatar bexdunn avatar awalshie avatar jeremyh avatar bellemae avatar smr547 avatar geoscience-aman avatar alexgleith avatar harshurampur avatar jmettes avatar margaretharrison avatar benjimin avatar benjamin-glitsos avatar walsh-andrew avatar dependabot[bot] avatar eloise-b avatar tom-butler avatar

Stargazers

 avatar Youssef Harby avatar  avatar  avatar Tisham Dhar avatar

Watchers

Tisham Dhar avatar James Cloos avatar nehem avatar Simon Oliver avatar Wenjun Wu avatar Lazar Bodor avatar Arnab Rakshit avatar Scott McLauchlan avatar Jaleel Ahmed Mohammad avatar  avatar  avatar  avatar  avatar

dea-knowledge-hub's Issues

Search Feature Not Working

When I try to search for something in the DEA User Guide, the search page opens, but no results are ever returned.

It looks like something has broken with the build of the site. If I look at the Javascript Console in my browser, there's an error message:

search.html?q=landsat&check_keywords=yes&area=default:146 Uncaught ReferenceError: jQuery is not defined
    at search.html?q=landsat&check_keywords=yes&area=default:146:7

JQuery is a Javascript library that should be included on the page, but for some reason is not. It could be something broken with the theme we use, or an incompatibility between something else and the theme.

Update pull request template to nudge users to update Sandbox updates banner

The new DEA Changelog is fantastic, and provides a great place for us to document changes and updates across DEA. However, we do run the risk of forgetting to also update the DEA Sandbox "Updates" banner, which is the other high profile location where we share updates with our users:

image

I would like to propose that we add two additional checklist items to the current pull request template, to encourage (but not force) users to keep our update sections up to date:

Refining the docs for DEA access on GADI

The recent upgrade to the documentation on accessing DEA from ARE is very welcome. However, recently I helped a PhD student at ANU get running on the NCI and the experience led to a few suggestions to improve the current docs.

  • This sentence is confusing for the user: It's also possible to use DEA on the NCI's Gadi HPC Supercomputer, however unless you're experienced with SSH and HPC systems, it's much easier to get started with ARE. Unlike the earlier iteration of Jupyterlab on the NCI which was hosted on NIRIN Cloud ("OOD"), ARE is on GADI and has full access to the supercomputer so this is something of a false dichotomy that leads to confusion. In my opinion, the docs should start with something like..."There are three ways to access DEA on NCI's GADI: VDI, ARE, or command line, here's how you do those..."

  • Overall, the docs for ARE are good, but for a new user the docs are a little sparse. I think more explicit detail might be necessary to help a new user get started (my test subject found it confusing without me guiding them through it). For example, some description of why you need to add v10 to the Storage options, or what the DEA environment is (just a sentence or two helps a lot), etc.

  • It would also be helpful to have a section on cloning dea-notebooks into a folder on ARE. As well as mentioning the need to change the sys.path.insert() location in dea-notebooks to make dea_tools work i.e.,

import sys
sys.path.insert(1, '/g/data/path/to/dea-notebooks/Tools')
  • For a completely new user getting started on ARE, is there a need to generate a pygpass in the home directory to get access to the database? I assumed this was created when a user runs sh /g/data/v10/public/digitalearthau/install.sh on the VDI (but I'm not sure). If so, then this step would need to be added as a first step whether using ARE, VDI, or command line.

  • Lastly, this is not directly related to the docs, but the default dea environment still hasn't been updated (it loads 20221025 env by default), which results in ModuleNotFoundError: No module named 'odc.geo' errors when trying to run any of the dea-notebooks. This is a huge blocker for people to get started as working around the issue is quite tricky if you're unfamiliar with managing python environments.

Happy to review any further updates to the docs

Thanks,
Chad

Duplication between docs Jupyter guide and 01_Jupyter_notebooks.ipynb

There's currently a bit of duplication between the content in this guide:

https://github.com/GeoscienceAustralia/dea-docs/blob/develop/setup/jupyter.rst

And the content in the 01_Jupyter_notebooks.ipynb notebook in the Beginners_guide:

https://github.com/GeoscienceAustralia/dea-notebooks/blob/develop/Beginners_guide/01_Jupyter_notebooks.ipynb

Do we mind? Should we combine these into one?

The examples are provided as Jupyter Notebooks, which can be run in either instance. Jupyter Notebooks contain code and explanations side-by-side so that you can understand the steps involved in an analysis. Our Jupyter Notebooks page provides a quick introduction to using Jupyter Notebooks. For a more detailed introduction, visit the Jupyter Notebook Documentation.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.