NREL-COMPASS 0.8.2

INFRA-COMPASS is a tool that leverages Large Language Models (LLMs) to create and maintain an inventory of state and local codes and ordinances applicable to energy infrastructure.

INFRA-COMPASS is an innovative software tool that harnesses the power of Large Language Models (LLMs) to automate the compilation and continued maintenance of an inventory of state and local codes and ordinances pertaining to energy infrastructure.

Installing INFRA-COMPASS

The quickest way to install INFRA-COMPASS for users is from PyPi:

pip install nrel-compass

If you would like to install and run INFRA-COMPASS from source, we recommend using pixi:

git clone [e-mail]:NREL/COMPASS.git; cd COMPASS
pixi run compass

Before performing any web searches (i.e. running the COMPASS pipeline), you will need to run the following command:

playwright install

If you are using pixi, don’t forget to prefix this command with pixi run or initialize a shell using pixi shell. For detailed instructions, see the installation documentation.

Quickstart

To run a quick INFRA-COMPASS demo, set up a personal OpenAI API key and run:

pixi run openai-solar-demo <your API key>

This will run a full extraction pipeline for two counties using gpt-4o-mini (costs ~$0.45). For more information on configuring an INFRA-COMPASS run, see the execution basics example.

Development

Please see the Development Guidelines if you wish to contribute code to this repository.