Skip to content
This repository has been archived by the owner on Apr 15, 2024. It is now read-only.

Latest commit

 

History

History
63 lines (42 loc) · 2.32 KB

README.rst

File metadata and controls

63 lines (42 loc) · 2.32 KB
Tox-PyTest Status Codecov Test Coverage Supported Python Versions Any color you want, so long as it's black.

This repository performs entity resolution to match the FERC Form 1 and EIA data. Funded by a grant from CCAI.

Installation

To install the software in this repository, clone it to your computer using git. If you're authenticating using SSH:

git clone [email protected]:catalyst-cooperative/ccai-entity-matching.git

Or if you're authenticating via HTTPS:

git clone https://github.com/catalyst-cooperative/ccai-entity-matching.git

Then in the top level directory of the repository, create a conda environment based on the environment.yml file that is stored in the repo:

conda env create --name ferc1_eia_match --file environment.yml

To run the pre-commit hooks before you commit code run:

pre-commit install

Note that the software in this repository depends on the dev branch of the main PUDL repository, and the setup.py in this repository indicates that it should be installed directly from GitHub. This can be a bit slow, as pip (which in this case is running inside of a conda environment) clones the entire history of the repository containing the package being installed. How long it takes will depend on the speed of your network connection. It might take ~5 minutes.

Thank You

Thank you to Climate Change AI. for awarding us a grant to conduct this work.