PUDL
v0.4.0
Introduction
Data Access
Data Sources
Data Dictionaries
Contributing
Development
Development Setup
Settings Files
Running the ETL Pipeline
Project Management
Testing PUDL
Building the Documentation
Working with the Datastore
Cloning the FERC Form 1 DB
Naming Conventions
Data and ETL Design Guidelines
Packaging and Dependencies
Licensing
Code of Conduct
Release Notes
Module Index
PUDL
»
Development
Edit on GitHub
Development
ΒΆ
Development Setup
Install conda
Fork and Clone the PUDL Repository
Create the PUDL Dev Environment
Getting and Storing an EIA API Key
Updating the PUDL Dev Environment
Set Up Code Linting
Creating a Workspace
Settings Files
Setttings for ferc1_to_sqlite
Settings for pudl_etl
Running the ETL Pipeline
The Fast ETL
The Full ETL
Additional Notes
Project Management
Issues and Project Tracking
GitHub Workflow
Pull Requests
Releases
User Support
Testing PUDL
Software Tests
Running tests with Tox
Selecting Input Data for Integration Tests
Data Validation
Running pytest Directly
Building the Documentation
Working with the Datastore
Adding a new Dataset to the Datastore
Cloning the FERC Form 1 DB
Naming Conventions
Glossary of Abbreviations
Data Extraction Functions
Output Functions
Table Names
Columns and Field Names
Data and ETL Design Guidelines
Input vs. Output Data
Minimize Data Alteration
Make Tidy Data
Use Simple Data Types
Use Consistent Units
Silo the ETL Process
Separate Data from Glue
Partition Big Data
Naming Conventions
Complete, Continuous Time Series
Packaging and Dependencies
setup.py
MANIFEST.in
pyproject.toml
Read the Docs
v: v0.4.0
Versions
latest
stable
v0.4.0
v0.3.2
v0.3.1
v0.3.0
v0.2.0
v0.1.0
dev
data-source-docs
Downloads
On Read the Docs
Project Home
Builds