powerdict 1.0.0

This module exposes a power station dictionary that enables mapping between various naming conventions and associated plant metadata

Power Station Dictionary

This repository exposes a power station dictionary that enables mapping between various naming conventions and associated plant metadata, it also explains how you can help contribute to this open-source project.

The core output of this project is a clean output power plant dataset that includes relevant attributes such as location and capacity, as well as id mappings that can be used to connect them to other datasets. The powerdict module will construct this dataset from the files contained in three of the data directories:

• raw - source datasets as csvs
• updates - JSON mappings from an osuked_id to a new attribute value
• definitions - JSON specification of how to process the raw sources

The output dataset can be found here

Installation

To install the powerdict library please run:

pip install powerdict

Development Set-Up

To create a new environment you can follow the following code blocks or run the setup_env batch script located in the batch_scripts directory.

git clone
conda env create -f environment.yml
conda activate powerdict

Publishing to PyPi

To publish the powerdict module to PyPi simply run the following from the batch_scripts directory

pypi_publish

When prompted you should enter your PyPi username and password

After this you will be able to install the latest version of powerdict using pip install powerdict

=================================================================

To Do:

• Corrections/additions should be able to be specified through JSON alone with clear instructions of where edits can be made
• Should carry out both standard and spatial merging of datasets
• All retreival, cleaning, and merging functions should be exported to a module
• The module should include pipelines that combine the processing steps for easy dispatch
• The pipelines should be set-up with GitHub actions to run every week or so in case of new updates