datacube-core icon indicating copy to clipboard operation
datacube-core copied to clipboard

Published 20 hours ago • verified publisher icon opendatacube

Improve documentation for dataset documents

Open MartinPontius opened this issue 2 years ago • 1 comments

  1. Add description of dataset documents to "latest" documentation The description of datasets on the "latest" documentation (https://datacube-core.readthedocs.io/en/latest/about-core-concepts/datasets.html) does not contain any explanation on how the metadata documents should look like in contrast to the description of products (https://datacube-core.readthedocs.io/en/latest/about-core-concepts/products.html). Probably it was forgotten when migrating from the old-style "stable" documentation (https://datacube-core.readthedocs.io/en/stable/ops/dataset_documents.html).

  2. Add explanation on how to index time-stacked netCDF files Working with time-stacked netCDF files is very common and being able to add them to the ODC index would be benefical as explained e.g. here: https://gis.stackexchange.com/questions/389481/how-to-index-and-load-a-time-stacked-netcdf-file-with-open-data-cube. Unfortunately, there is no documentation on how to do this (at least I could not find any). With some research I managed to find out how it works (from here: https://github.com/opendatacube/datacube-core/pull/449/commits/5723c040fc5aeacc638756ea21e395d491202bf8). The time index can be defined by appending a fragment (#part=<index>) to the uri in the path attribute of the metadata document. It starts from 0. Important to note that it was also necessary to prepend file:// to make it work.

MartinPontius avatar Feb 14 '22 16:02 MartinPontius

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] avatar Jun 18 '22 18:06 stale[bot]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] avatar Mar 18 '23 04:03 stale[bot]

Point 1 in the issue description is outdated as the missing documentation has been added in the mean time (see https://github.com/opendatacube/datacube-core/blob/develop/docs/installation/dataset-documents.rst or https://datacube-core.readthedocs.io/en/latest/installation/dataset-documents.html).

For point 2, I added a PR: https://github.com/opendatacube/datacube-core/pull/1430

MartinPontius avatar Mar 31 '23 14:03 MartinPontius