Skip to content

Documentation Overview

This page maps the documentation layout so you know where to look first. It explains the purpose of each section and suggests a reading order based on whether you need concepts, operations, data, or workflows.

Use Learn for guided lessons, Library for nouns and verbs, Documents for technical detail, and Vignettes for runnable analysis stories.

How the sections fit together

  • Home: primary landing page with quick links to major sections.
  • Concepts: mental model of cubes, pipes, and verbs.
  • Getting Started: installation, configuration, and a minimal pipeline.
  • Capabilities: overview of verbs and what they enable.
  • Datasets: supported sources, semantics, and how to choose.
  • Recipes: applied workflows built from verbs and datasets.
  • Visualization: cube-aware viewers and mapping tools.
  • Reference: API docs plus scope, deprecations, and legacy notes.

Suggested reading order

  1. Start at Home to pick a destination.
  2. Skim Concepts to align on terminology.
  3. Run Getting Started for a first success.
  4. Browse Capabilities and Verbs & Examples to plan operations.
  5. Choose a source from Datasets and follow a Recipe.
  6. Use Visualization to inspect results, then dive into the API Reference as needed.