Skip to main content

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.

Project description

License Zenodo PythonV PyPi Ruff Pixi Static Badge

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 infra-compass

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

git clone git@github.com:NatLabRockies/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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

infra_compass-0.15.1.tar.gz (623.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

infra_compass-0.15.1-py3-none-any.whl (638.4 kB view details)

Uploaded Python 3

File details

Details for the file infra_compass-0.15.1.tar.gz.

File metadata

  • Download URL: infra_compass-0.15.1.tar.gz
  • Upload date:
  • Size: 623.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for infra_compass-0.15.1.tar.gz
Algorithm Hash digest
SHA256 0d17a48b6b866725adefbbc50ce582bd74b036c8df05b23454749340c9b3d98b
MD5 f33f777db898552a70736ace0b9a027c
BLAKE2b-256 cd52c67dd27998c968385720e10372718e3b47b845f62652b77fda7ad2a179b1

See more details on using hashes here.

Provenance

The following attestation bundles were made for infra_compass-0.15.1.tar.gz:

Publisher: publish_to_pypi.yml on NatLabRockies/COMPASS

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file infra_compass-0.15.1-py3-none-any.whl.

File metadata

  • Download URL: infra_compass-0.15.1-py3-none-any.whl
  • Upload date:
  • Size: 638.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for infra_compass-0.15.1-py3-none-any.whl
Algorithm Hash digest
SHA256 bbe397f3b358d7680d263fcd74396608f6973c3f8083486576fcd4baeb640405
MD5 9432c279e0b0684fb9794f49273a0331
BLAKE2b-256 4ca7880e1f2c240e8acb4b47ba5248b72bcddbd7890242284866c9e379edaea2

See more details on using hashes here.

Provenance

The following attestation bundles were made for infra_compass-0.15.1-py3-none-any.whl:

Publisher: publish_to_pypi.yml on NatLabRockies/COMPASS

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page