Skip to content

Latest commit

 

History

History
37 lines (21 loc) · 1.3 KB

README.md

File metadata and controls

37 lines (21 loc) · 1.3 KB
Raw

cumulus-process-py

CircleCI PyPI version

cumulus-process-py is a collection of python utilities for the NASA Cumulus project.

The Use Case

This library provides various utilities and helper functions for python tasks developed to work with the Cumulus framework.

The utilities help writing tasks that involve metadata extraction from input files, thumbnail creation, or even more complex data processing such as running custom science code to create higher level products from an input file.

Installation

$ pip install cumulus-process

Development

$ pip install -r requirements.txt
$ pip install -r requirements-dev.txt

Testing

Testing requires localstack. Follow the instruction for localstack and install it on your machine then:

$ nose2 -v

Usage

To use the library, subclass Process class from cumulus_process and implement:

  1. the process method,
  2. a default_keys property (needed for functionality such as self.fetch() unless you are overriding input_keys in config)

Example:

See the example folder.