Welcome to pycovjson’s documentation!

Contents:

Introduction to pycovjson

Introduction

pycovjson is a python utility library for creating CoverageJSON files from common scientific data formats (e.g NetCDF).

What does pycovjson offer?

The library provides a packaged Python API for the generation of CoverageJSON which is compliant with the CoverageJSON Format Specification.

Quickstart

Purpose

The following document explains how to quickly get up and running with pycovjson. It explains how to execute the key commands and explains (at a high level) what those commands are doing e.g. what input and output we can expect. More detail on expressive use of the various API’s including function level API documentation can be found in subsequent pages of this documentation guide.

CoverageJSON Generation

cli.py

This is very simple...

# ....some code

More on using pycovjson functions later...

Conclusion

That concludes the quick start. Hopefully this has been helpful in providing an overview of the main pycovjson features. If you have any issues with this document then please register them at the issue tracker. Please use labels to classify your issue.

Command Line Interface

Convert Module

Viewer Module

pycovjson main.py

pycovjson model.py

coverage

pycovjson convertpy

pycovjson read_netcdf.py

pycovjson setup.py

pycovjson write.py

Indices and tables