Skip to content

Create missing Data Source documentation pages #4330

Open
@zaneselvans

Description

@zaneselvans

Overview

We have accumulated a number of data sources that are pretty well integrated into PUDL -- providing one or more tables that we expect people to be able to use -- but that do not yet have data source documentation pages explaining what the data source overall is, where it comes from, it's limitations, quirks, and potential use cases.

  • These pages should go under docs/data_sources
  • Content will come from src/pudl/metadata/sources.py + Jinja templates in docs/templates
  • References from "Other Data in PUDL" should be removed when they have their own pages.
  • Make sure we add them to the TOC for the data sources doc index.
  • Find references to the data sources elsewhere in the documentation and add links to their data source page.

Data Sources to Document

Turn each these into sub-issues with more detail about each data source and an independent PR for each one.

  • sec10k (work in progress, but we need to recruit additional support, and there's a lot to describe)
  • nrelatb
  • eiaaeo (partially integrated, but we'd love people to pay us to bring in other things)
  • censusdp1tract (used for geometries and basic census data)
  • eia_bulk_elec (archive renamed to eiaapi -- just the Electricity subset is integrated into PUDL)
  • epacamd_eia (crosswalk -- should definitely link to this from epacems data source page too)

Metadata

Metadata

Assignees

No one assigned

    Labels

    censusdp1tractIssues related to the Census DP1 dataset which we distribute as an SQLite DBdocsDocumentation for users and contributors.eia_bulk_eleceiaaeoEIA Annual Energy OutlookepacemsIntegration and analysis of the EPA CEMS dataset.epicAny issue whose primary purpose is to organize other issues into a group.nrelatbNREL's Annual Technology Baseline datasec10kIssues related to SEC 10K filing data.

    Type

    No type

    Projects

    Status

    New

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions