Data

Tools

Indexes

Applications

Experiments

Open Source Science

infra-compass-cli

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.

https://github.com/nrel/compass

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.2%) to scientific vocabulary

Keywords

ai automation energy-analysis energy-policy infrastructure llm ordinances permitting siting
Last synced: 6 months ago · JSON representation

Repository

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.

Basic Info
Statistics
  • Stars: 12
  • Watchers: 4
  • Forks: 0
  • Open Issues: 31
  • Releases: 17
Topics
ai automation energy-analysis energy-policy infrastructure llm ordinances permitting siting
Created about 1 year ago · Last pushed 6 months ago
Metadata Files
Readme License Citation Support

README.rst 

*******************************************************************************************
Infrastructure Continuous Ordinance Mapping for Planning and Siting Systems (INFRA-COMPASS)
*******************************************************************************************

|License| |PythonV| |PyPi| |Ruff| |Pixi| |SWR|

.. |PythonV| image:: https://badge.fury.io/py/NREL-COMPASS.svg
    :target: https://pypi.org/project/NREL-COMPASS/

.. |PyPi| image:: https://img.shields.io/pypi/pyversions/NREL-COMPASS.svg
    :target: https://pypi.org/project/NREL-COMPASS/

.. |Ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
    :target: https://github.com/astral-sh/ruff

.. |License| image:: https://img.shields.io/badge/License-BSD_3--Clause-orange.svg
    :target: https://opensource.org/licenses/BSD-3-Clause

.. |Pixi| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/prefix-dev/pixi/main/assets/badge/v0.json
    :target: https://pixi.sh

.. |SWR| image:: https://img.shields.io/badge/SWR--25--62_-blue?label=NREL
    :alt: Static Badge

.. inclusion-intro


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:

.. code-block:: bash

    pip install nrel-compass

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

.. code-block:: bash

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

.. code-block:: shell

    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:

.. code-block:: shell

    pixi run openai-solar-demo 

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.

Owner

  • Name: National Renewable Energy Laboratory
  • Login: NREL
  • Kind: organization
  • Location: Golden, CO

GitHub Events

Total
  • Create event: 100
  • Issues event: 26
  • Release event: 8
  • Watch event: 11
  • Delete event: 91
  • Member event: 2
  • Issue comment event: 58
  • Public event: 1
  • Push event: 380
  • Pull request review comment event: 14
  • Pull request review event: 40
  • Pull request event: 170
Last Year
  • Create event: 100
  • Issues event: 26
  • Release event: 8
  • Watch event: 11
  • Delete event: 91
  • Member event: 2
  • Issue comment event: 58
  • Public event: 1
  • Push event: 380
  • Pull request review comment event: 14
  • Pull request review event: 40
  • Pull request event: 170

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 27
  • Total pull requests: 173
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 2 days
  • Total issue authors: 2
  • Total pull request authors: 5
  • Average comments per issue: 0.33
  • Average comments per pull request: 0.4
  • Merged pull requests: 151
  • Bot issues: 0
  • Bot pull requests: 18
Past Year
  • Issues: 27
  • Pull requests: 173
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 2 days
  • Issue authors: 2
  • Pull request authors: 5
  • Average comments per issue: 0.33
  • Average comments per pull request: 0.4
  • Merged pull requests: 151
  • Bot issues: 0
  • Bot pull requests: 18
View more stats
Top Authors
Issue Authors
  • ppinchuk (23)
  • castelao (4)
Pull Request Authors
  • ppinchuk (115)
  • castelao (38)
  • dependabot[bot] (18)
  • xtruan (1)
  • bpulluta (1)
Top Labels
Issue Labels
enhancement (11) p-medium (7) chore (6) p-high (6) p-low (5) topic-rust-duckdb (4) topic-python-general (3) topic-python-cli (3) topic-python-llm (2) new computation (2) refactor (2) topic-rust-cli (2) topic-python-async (1) documentation (1) github_actions (1) dependencies (1)
Pull Request Labels
enhancement (68) p-high (38) chore (36) p-medium (34) dependencies (33) topic-python-llm (25) github_actions (18) p-low (16) documentation (13) bugfix (12) refactor (10) topic-python-cli (9) topic-rust-duckdb (9) p-critical (8) topic-python-general (7) topic-rust-general (5) breaking (5) new computation (3) deprecation (2) topic-python-async (2) rust (2) topic-rust-cli (1)

Packages

  • Total packages: 3
  • Total downloads:
    • cargo 2,901 total
    • pypi 33 last-month
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 0
    (may contain duplicates)
  • Total versions: 15
  • Total maintainers: 4
pypi.org: nrel-compass

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.

  • Versions: 8
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 33 Last month
Rankings
Dependent packages count: 9.4%
Average: 31.0%
Dependent repos count: 52.7%
Maintainers (2)
castelao ppinchuk-nrel
Last synced: 6 months ago
crates.io: infra-compass-db

Parse and manage the NREL's INFRA-COMPASS data

  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 2,053 Total
Rankings
Dependent repos count: 22.2%
Dependent packages count: 29.5%
Average: 49.1%
Downloads: 95.7%
Maintainers (2)
castelao ppinchuk
Last synced: 6 months ago
crates.io: infra-compass-cli

Command line application to manage and query NREL's INFRA-COMPASS data

  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 848 Total
Rankings
Dependent repos count: 22.2%
Dependent packages count: 29.5%
Average: 49.1%
Downloads: 95.7%
Maintainers (2)
castelao ppinchuk
Last synced: 6 months ago

Dependencies

.github/workflows/ci-rust.yml actions
  • Swatinem/rust-cache v2 composite
  • actions/checkout v4 composite
  • prefix-dev/setup-pixi v0.8.1 composite
.github/workflows/docs.yml actions
  • actions/checkout v4 composite
  • peaceiris/actions-gh-pages v3.6.1 composite
  • prefix-dev/setup-pixi v0.8.4 composite
.github/workflows/lint-python.yml actions
  • actions/checkout v4 composite
  • astral-sh/ruff-action v3 composite
.github/workflows/publish_to_pypi.yml actions
  • actions/checkout v4 composite
  • prefix-dev/setup-pixi v0.8.4 composite
.github/workflows/release-cli.yml actions
  • actions-rs/cargo v1 composite
  • actions-rs/toolchain v1 composite
  • actions/checkout v4 composite
  • svenstaro/upload-release-action v2 composite
.github/workflows/release_drafter.yml actions
  • release-drafter/release-drafter v5.15.0 composite
Cargo.lock cargo
  • 208 dependencies
Cargo.toml cargo
crates/cli/Cargo.toml cargo
crates/compass/Cargo.toml cargo
pyproject.toml pypi
  • click >=8.1.7,<9
  • langchain >=0.3.7,<0.4
  • networkx >=3.4.2,<4
  • nltk >=3.9.1,<4
  • nrel-elm >=0.0.12,<1
  • openai >=1.1.0
  • pandas >=2.2.3,<3
  • pyjson5 >=1.6.8,<2
  • rich >=13.9.4,<14