Welcome to Catalog Builder’s documentation!

The Catalog Builder API will collect building blocks necessary to build a data catalog which can then be ingested in climate analysis scripts/workflow, leveraging the use of intake-esm and xarray.

Tested on posix file system, S3 and GFDL post-processed (select simulations, components) at this time. This repository has unit tests (pytest) and incorporated the same in GitHub Actions, when a PR is open or a push is initiated.

See our Github repository here.

Contents:

• Background
  • Brief overview on data catalogs
• Generating data catalogs
  • Installation
  • Expected output
  • Using conda package
  • From Jupyter Notebook
  • Using FRE-CLI (GFDL only)
  • Optional Configuration
• Using data catalogs
  • Example notebooks
  • How to ingest using Intake-ESM
• Presentation links

Indices and tables

• Index

• Module Index

• Search Page