Metadata-Version: 2.1
Name: eodatasets3
Version: 0.3.0
Summary: Packaging, metadata and provenance for OpenDataCube EO3 datasets
Home-page: https://github.com/GeoscienceAustralia/eo-datasets
Author: Open Data Cube
License: Apache Software License 2.0
Description: ## Earth Observation Datasets
        
        [![Build Status](https://travis-ci.org/GeoscienceAustralia/eo-datasets.svg?branch=eodatasets3)](https://travis-ci.org/GeoscienceAustralia/eo-datasets)
        [![Coverage Status](https://coveralls.io/repos/GeoscienceAustralia/eo-datasets/badge.svg?branch=eodatasets3)](https://coveralls.io/r/GeoscienceAustralia/eo-datasets?branch=eodatasets3)
        
        Packaging, metadata and provenance libraries for GA EO datasets. See [LICENSE](LICENSE) for
        license details.
        
        ### Installation
        
            pip install -e .
        
        Python 3.6+ is supported. A [GDAL](http://www.gdal.org/) installation is required 
        to use most packaging commands.
        
        ### Development
        
        Run tests using [pytest](http://pytest.org/).
        
            pytest
        
        All code is formatted using [black](https://github.com/ambv/black), and checked
        with [pyflakes](https://github.com/PyCQA/pyflakes).
        
        They are included when installing the test dependencies:
        
            pip install -e .[test]
        
        You may want to configure your editor to run black automatically on file save
        (see the Black page for directions), or install the pre-commit hook within Git:
        
        ### Pre-commit setup
        
        A [pre-commit](https://pre-commit.com/) config is provided to automatically format
        and check your code changes. This allows you to immediately catch and fix
        issues before you raise a failing pull request (which run the same checks under
        Travis).
        
        If you don't use Conda, install pre-commit from pip:
        
            pip install pre-commit
        
        If you do use Conda, install from conda-forge (*required* because the pip
        version uses virtualenvs which are incompatible with Conda's environments)
        
            conda install pre_commit
        
        Now install the pre-commit hook to the current repository:
        
            pre-commit install
        
        Your code will now be formatted and validated before each commit. You can also
        invoke it manually by running `pre-commit run`
        
            
        
        ### Included Scripts
        
        `eo3-validate` a lint-like checker to check ODC metadata.
        
             $ eo3-validate --help
            Usage: eo3-validate [OPTIONS] [PATHS]...
            
              Validate ODC dataset documents
            
              Paths can be both product and dataset documents, but each product must
              come before its datasets to be matched against it.
            
            Options:
              -W, --warnings-as-errors  Fail if any warnings are produced
              --thorough                Attempt to read the data/measurements, and check
                                        their properties match the product
              -q, --quiet               Only print problems, one per line
              --help                    Show this message and exit.
        
        `eo3-prepare`: Prepare ODC metadata from the commandline.
        
        Some preparers need the ancillary dependencies: `pip install .[ancillary]`
        
             $ eo3-prepare --help
            Usage: eo3-prepare [OPTIONS] COMMAND [ARGS]...
            
            Options:
              --version  Show the version and exit.
              --help     Show this message and exit.
            
            Commands:
              landsat-l1     Prepare eo3 metadata for USGS Landsat Level 1 data.
              modis-mcd43a1  Prepare MODIS MCD43A1 tiles for indexing into a Data...
              noaa-prwtr     Prepare NCEP/NCAR reanalysis 1 water pressure datasets...
              s2-awspds      Preparation code for Sentinel-2 L1C AWS PDS Generates...
              s2-cophub      Preparation code for Sentinel-2 L1C SCIHUB ZIP Generates...
        
        `eo3-package-wagl`: Convert and package WAGL HDF5 outputs.
        
         Needs the wagl dependencies group: `pip install .[wagl]`
             
             $ eo3-package-wagl --help
            Usage: eo3-package-wagl [OPTIONS] H5_FILE
            
              Package WAGL HDF5 Outputs
            
              This will convert the HDF5 file (and sibling fmask/gqa files) into
              GeoTIFFS (COGs) with datacube metadata using the DEA naming conventions
              for files.
            
            Options:
              --level1 FILE                   Optional path to the input level1 metadata
                                              doc (otherwise it will be loaded from the
                                              level1 path in the HDF5)
              --output DIRECTORY              Put the output package into this directory
                                              [required]
              -p, --product [nbar|nbart|lambertian|sbt]
                                              Package only the given products (can specify
                                              multiple times)
              --with-oa / --no-oa             Include observation attributes (default:
                                              true)
              --help                          Show this message and exit.
        
        `eo3-to-stac`: Convert an ODC metadata to a Stac Item json file (BETA/Incomplete)
        
             $ eo3-to-stac --help
            Usage: eo3-to-stac [OPTIONS] [ODC_METADATA_FILES]...
            
              Convert a new-style ODC metadata doc to a Stac Item.
            
            Options:
              --help  Show this message and exit.
        
        # Metadata creation API
        
        _TODO: Write an overview._ 
        
        See an example in [tests/integration/test_assemble.py](tests/integration/test_assemble.py)
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Provides-Extra: ancillary
Provides-Extra: all
Provides-Extra: test
Provides-Extra: wagl
