| Name | NREL-COMPASS JSON |
| Version |
0.8.0
JSON |
| download |
| home_page | None |
| Summary | 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. |
| upload_time | 2025-07-21 21:47:31 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12 |
| license | None |
| keywords |
compass
nrel
ordinance
database
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
*******************************************************************************************
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 <https://pixi.sh/latest/>`_:
.. 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 <https://nrel.github.io/COMPASS/misc/installation.html>`_.
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 <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 <https://nrel.github.io/COMPASS/examples/execution_basics/README.html>`_.
Development
===========
Please see the `Development Guidelines <https://nrel.github.io/COMPASS/dev/index.html>`_
if you wish to contribute code to this repository.
Raw data
{
"_id": null,
"home_page": null,
"name": "NREL-COMPASS",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": "Paul Pinchuk <ppinchuk@nrel.gov>, Guilherme Castel\u00e3o <gpimenta@nrel.gov>",
"keywords": "COMPASS, NREL, Ordinance, Database",
"author": null,
"author_email": "Paul Pinchuk <ppinchuk@nrel.gov>, Guilherme Castel\u00e3o <gpimenta@nrel.gov>",
"download_url": "https://files.pythonhosted.org/packages/28/60/4d0ea349422640924469dba1c1640ed1c96f22cfc9f9afaa41eef9cefae1/nrel_compass-0.8.0.tar.gz",
"platform": null,
"description": "*******************************************************************************************\nInfrastructure Continuous Ordinance Mapping for Planning and Siting Systems (INFRA-COMPASS)\n*******************************************************************************************\n\n|License| |PythonV| |PyPi| |Ruff| |Pixi| |SWR|\n\n.. |PythonV| image:: https://badge.fury.io/py/NREL-COMPASS.svg\n :target: https://pypi.org/project/NREL-COMPASS/\n\n.. |PyPi| image:: https://img.shields.io/pypi/pyversions/NREL-COMPASS.svg\n :target: https://pypi.org/project/NREL-COMPASS/\n\n.. |Ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n :target: https://github.com/astral-sh/ruff\n\n.. |License| image:: https://img.shields.io/badge/License-BSD_3--Clause-orange.svg\n :target: https://opensource.org/licenses/BSD-3-Clause\n\n.. |Pixi| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/prefix-dev/pixi/main/assets/badge/v0.json\n :target: https://pixi.sh\n\n.. |SWR| image:: https://img.shields.io/badge/SWR--25--62_-blue?label=NREL\n :alt: Static Badge\n\n.. inclusion-intro\n\n\nINFRA-COMPASS is an innovative software tool that harnesses the power of Large Language Models (LLMs)\nto automate the compilation and continued maintenance of an inventory of state and local codes\nand ordinances pertaining to energy infrastructure.\n\n\nInstalling INFRA-COMPASS\n========================\nThe quickest way to install INFRA-COMPASS for users is from PyPi:\n\n.. code-block:: bash\n\n pip install nrel-compass\n\nIf you would like to install and run INFRA-COMPASS from source, we recommend using `pixi <https://pixi.sh/latest/>`_:\n\n.. code-block:: bash\n\n git clone git@github.com:NREL/COMPASS.git; cd COMPASS\n pixi run compass\n\nBefore performing any web searches (i.e. running the COMPASS pipeline), you will need to run the following command:\n\n.. code-block:: shell\n\n playwright install\n\nIf you are using ``pixi``, don't forget to prefix this command with ``pixi run`` or initialize a shell using ``pixi shell``.\nFor detailed instructions, see the `installation documentation <https://nrel.github.io/COMPASS/misc/installation.html>`_.\n\n\nQuickstart\n==========\nTo run a quick INFRA-COMPASS demo, set up a personal OpenAI API key and run:\n\n.. code-block:: shell\n\n pixi run openai-solar-demo <your API key>\n\nThis will run a full extraction pipeline for two counties using ``gpt-4o-mini`` (costs ~$0.45).\nFor more information on configuring an INFRA-COMPASS run, see the\n`execution basics example <https://nrel.github.io/COMPASS/examples/execution_basics/README.html>`_.\n\n\nDevelopment\n===========\nPlease see the `Development Guidelines <https://nrel.github.io/COMPASS/dev/index.html>`_\nif you wish to contribute code to this repository.\n",
"bugtrack_url": null,
"license": null,
"summary": "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.",
"version": "0.8.0",
"project_urls": {
"documentation": "https://nrel.github.io/COMPASS/",
"homepage": "https://github.com/NREL/COMPASS",
"repository": "https://github.com/NREL/COMPASS"
},
"split_keywords": [
"compass",
" nrel",
" ordinance",
" database"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "76e667377e137c2b82cb13ec9b9fd25f89e23c607d83c21d4f4fd68024dc624e",
"md5": "d5b1d2ae168c0529ff23299282bc316a",
"sha256": "7cdd5e1dd0a19c5bb559b35f33a3cb98a2e12c0b02b74dd696bbba656cfef119"
},
"downloads": -1,
"filename": "nrel_compass-0.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d5b1d2ae168c0529ff23299282bc316a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 217251,
"upload_time": "2025-07-21T21:47:30",
"upload_time_iso_8601": "2025-07-21T21:47:30.501634Z",
"url": "https://files.pythonhosted.org/packages/76/e6/67377e137c2b82cb13ec9b9fd25f89e23c607d83c21d4f4fd68024dc624e/nrel_compass-0.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "28604d0ea349422640924469dba1c1640ed1c96f22cfc9f9afaa41eef9cefae1",
"md5": "65e859674c7c54541d59e73ada591528",
"sha256": "b20869c563b7fad37d9867f37dc253f666953d4ab5f2d3f9a88ae8e8ecde38bc"
},
"downloads": -1,
"filename": "nrel_compass-0.8.0.tar.gz",
"has_sig": false,
"md5_digest": "65e859674c7c54541d59e73ada591528",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 220381,
"upload_time": "2025-07-21T21:47:31",
"upload_time_iso_8601": "2025-07-21T21:47:31.561276Z",
"url": "https://files.pythonhosted.org/packages/28/60/4d0ea349422640924469dba1c1640ed1c96f22cfc9f9afaa41eef9cefae1/nrel_compass-0.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-21 21:47:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NREL",
"github_project": "COMPASS",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "nrel-compass"
}
