catalyst-cooperative / pudl

The Public Utility Data Liberation Project provides analysis-ready energy system data to climate advocates, researchers, policymakers, and journalists.
https://catalyst.coop/pudl
MIT License
456 stars 106 forks source link

Enumerate and specify PUDL configuration file types #376

Closed zaneselvans closed 4 years ago

zaneselvans commented 4 years ago

We have several different settings / configuration file types that we are using to control our scripts and automated processes, but nowhere do we have any documentation of what all those file types are, what they're used for, what they are allowed to have in them, what they must have in them, whether they can be merged together and used for more than one kind of script, etc.

We need to explicitly define and document what these different input files look like. It seems like they at least include files that control:

In addition, there's the .pudl.yml file that defines a user's default workspace.

zaneselvans commented 4 years ago

We added basic descriptions in the docs. epacems_to_parquet and pudl_data are still command line onley.