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-compassIf you would like to install and run INFRA-COMPASS from source, we recommend using pixi:
git clone git@github.com:NREL/COMPASS.git; cd COMPASS
pixi run compassBefore performing any web searches (i.e. running the COMPASS pipeline), you will need to run the following command:
playwright installIf 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.
2 maintainers
Metadata
2 maintainers
Release files for NREL-COMPASS 0.12.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| nrel_compass-0.12.0.tar.gz | 581.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| nrel_compass-0.12.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.2 MB
Release files / nrel_compass-0.12.0.tar.gz
| Download URL | nrel_compass-0.12.0.tar.gz |
|---|---|
| Size | 581.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
939b5b62a762e078dad7d11521bd8f67c07a66ba8b975019f3fc260aff2fe997
|
|
BLAKE2b-256 checksum How to use checksums |
113544fc97ce7629d30ed5fdc095e0929e5a69e10c0bb739eeb2680d2ae4face
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.11
|
Release files / nrel_compass-0.12.0-py3-none-any.whl
| Download URL | nrel_compass-0.12.0-py3-none-any.whl |
|---|---|
| Size | 585.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6114993f36828456e7bd237041d3e719dbb01d471ab207b7daa652b79a0c945e
|
|
BLAKE2b-256 checksum How to use checksums |
f3a223372b300e7ee788c4b765f773d4a82f06823b87576c03c5af30d07b9022
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.11
|
