Developer Guide

In this developer guide, you will find detailed guidelines and examples for contributing to eoio.

• Contributing to eoio
  • Development Workflow
• Readers
  • Overview
  • Useful API References
    • eoio.readers.factory.ReaderFactory
    • eoio.readers.base.BaseReader
    • eoio.readers.base.BaseRasterReader
    • eoio.readers.base.BaseInSituReader
  • Base Classes
  • Creating a Reader Class
    • Required Contract
    • Public Entrypoint
    • Minimal Example
    • Variable Selection
    • Subsetting
    • Helper Modules
    • Lazy Optional Dependencies
  • Output Dataset Requirements
    • Required Global Attributes
    • Required Variable Attributes
    • Flag Variables (Masks)
    • Dimension Naming
  • Registering a Reader
• Writers
  • Overview
  • Useful API References
    • eoio.writers.base.BaseWriter
    • eoio.writers.base.WriteCapability
    • eoio.writers.base.WriterConfig
    • eoio.writers.factory.WriterFactory
    • register_writer
  • Selecting a Writer
  • Creating a Writer Class
    • Required Contract
    • Public Entrypoint
    • Minimal Example
  • Base Write Parameters
  • Declaring Capability
  • Attribute Encoding
  • Provenance
  • Registering a Writer
  • Testing
• Processors
  • Overview
  • Useful API References
    • register_processor
    • eoio.processors.processor_pipeline.ProcessorPipeline
  • Creating a Processor
    • Required Contract
    • Context
    • Minimal Example
    • Error Handling
  • Registration
    • Built-in Processors
    • User-Defined Processors
    • Processor Naming Convention
  • ProcessorPipeline
• Controlled Vocabulary
  • Standards Alignment
  • Dataset (Global) Attributes
    • CF / ACDD Required Attributes
    • eoio-Specific Required Attributes
  • Controlled Values — Platform
  • Controlled Values — Instrument
  • Controlled Values — Processing Level
  • Variable Attributes
    • CF-Aligned Variable Attributes
    • eoio-Specific Variable Attributes
  • Dimension Naming
    • Canonical Dimensions
    • Multi-Resolution Grids