Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ body:
required: true
- label: >
I have confirmed this bug exists on the
[latest version](https://github.com/NREL/COMPASS/releases/latest) of COMPASS.
[latest version](https://github.com/NatLabRockies/COMPASS/releases/latest) of COMPASS.
required: true
- label: >
I have confirmed this bug exists on the main branch of COMPASS.
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/documentation_improvement.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ body:
options:
- label: >
I have checked that the issue still exists on the latest versions of the docs
on `main` [here](https://nrel.github.io/COMPASS/)
on `main` [here](https://natlabrockies.github.io/COMPASS/)
required: true
- type: textarea
id: location
attributes:
label: Location of the documentation
description: >
Please provide the location of the documentation,
# placeholder: https://nrel.github.io/gaps/_autosummary/gaps.config.load_config.html#gaps.config.load_config
# placeholder: https://natlabrockies.github.io/gaps/_autosummary/gaps.config.load_config.html#gaps.config.load_config
validations:
required: true
- type: textarea
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/installation_issue.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ body:
label: Installation check
options:
- label: >
I have read the [installation guide](https://nrel.github.io/COMPASS/misc/installation.html).
I have read the [installation guide](https://natlabrockies.github.io/COMPASS/misc/installation.html).
required: true
- type: input
id: platform
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/ci-python.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ jobs:
environments: pdev

- run: |
pixi reinstall -e pdev --locked NREL-COMPASS
pixi reinstall -e pdev --locked INFRA-COMPASS
pixi run -e pdev --locked tests-u

unit-tests:
Expand Down Expand Up @@ -90,7 +90,7 @@ jobs:
environments: pdev

- run: |
pixi reinstall -e pdev NREL-COMPASS
pixi reinstall -e pdev INFRA-COMPASS
pixi run -e pdev tests-u

integration-tests:
Expand Down Expand Up @@ -119,7 +119,7 @@ jobs:
environments: pdev

- run: |
pixi reinstall -e pdev NREL-COMPASS
pixi reinstall -e pdev INFRA-COMPASS
pixi run -e pdev tests-i

tox-tests:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/codecov.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ jobs:

- name: Generate coverage report
run: |
pixi reinstall -e pdev --locked NREL-COMPASS
pixi reinstall -e pdev --locked INFRA-COMPASS
pixi run -e pdev --locked tests-p

- name: Upload coverage to Codecov
Expand Down
2 changes: 1 addition & 1 deletion CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ authors:
identifiers:
- type: doi
value: 10.11578/dc.20250415.3
repository-code: 'https://github.com/NREL/COMPASS'
repository-code: 'https://github.com/NatLabRockies/COMPASS'
abstract: >-
INFRA-COMPASS is an innovative software tool utilizing
Large Language Models (LLMs) to systematically compile and
Expand Down
6 changes: 3 additions & 3 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ resolver = "2"
[workspace.package]
version = "0.0.8"
authors = [
"Guilherme Castelão <gpimenta@nrel.gov>",
"Paul Pinchuk <Pavlo.Pinchuk@nrel.gov>",
"Guilherme Castelão <gpimenta@nlr.gov>",
"Paul Pinchuk <Pavlo.Pinchuk@nlr.gov>",
]
edition = "2024"
license = "BSD-3-Clause"
rust-version = "1.87.0"
repository = "https://github.com/NREL/COMPASS"
repository = "https://github.com/NatLabRockies/COMPASS"
categories = ["data-structures", "science"]
keywords = ["NLR", "database", "energy", "ordinance"]

Expand Down
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ RUN pixi run --frozen -e pbuild build-wheels
# RUN pixi add --frozen pip
# RUN pixi run --frozen -e ${PIXI_ENV} \
# python3 -m pip install --no-deps --disable-pip-version-check \
# dist/nrel_compass-*.whl
# dist/infra__compass-*.whl
# Do we want to remove pip to reduce production's size?
# RUN pixi remove --frozen -e ${PIXI_ENV} pip

Expand Down
18 changes: 9 additions & 9 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ Infrastructure Continuous Ordinance Mapping for Planning and Siting Systems (INF

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

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

.. |PyPi| image:: https://img.shields.io/pypi/pyversions/NREL-COMPASS.svg
:target: https://pypi.org/project/NREL-COMPASS/
.. |PyPi| image:: https://img.shields.io/pypi/pyversions/INFRA-COMPASS.svg
:target: https://pypi.org/project/INFRA-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
Expand Down Expand Up @@ -39,13 +39,13 @@ The quickest way to install INFRA-COMPASS for users is from PyPi:

.. code-block:: bash

pip install nrel-compass
pip install infra-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
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:
Expand All @@ -55,7 +55,7 @@ Before performing any web searches (i.e. running the COMPASS pipeline), you will
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>`_.
For detailed instructions, see the `installation documentation <https://natlabrockies.github.io/COMPASS/misc/installation.html>`_.


Quickstart
Expand All @@ -68,10 +68,10 @@ To run a quick INFRA-COMPASS demo, set up a personal OpenAI API key and run:

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>`_.
`execution basics example <https://natlabrockies.github.io/COMPASS/examples/execution_basics/README.html>`_.


Development
===========
Please see the `Development Guidelines <https://nrel.github.io/COMPASS/dev/index.html>`_
Please see the `Development Guidelines <https://natlabrockies.github.io/COMPASS/dev/index.html>`_
if you wish to contribute code to this repository.
4 changes: 2 additions & 2 deletions compass/utilities/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ def title_preserving_caps(string):

Examples
--------
>>> title_preserving_caps("NREL solar ordinance")
'NREL Solar Ordinance'
>>> title_preserving_caps("NLR solar ordinance")
'NLR Solar Ordinance'
"""
return " ".join(map(_cap, string.split(" ")))

Expand Down
2 changes: 1 addition & 1 deletion compass/utilities/logs.py
Original file line number Diff line number Diff line change
Expand Up @@ -491,7 +491,7 @@ def log_versions(logger):

logger.info("Running COMPASS version %s", __version__)
packages_to_log = [
"NREL-ELM",
"NLR-ELM",
"openai",
"playwright",
"tf-playwright-stealth",
Expand Down
4 changes: 2 additions & 2 deletions crates/cli/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ authors.workspace = true
edition.workspace = true
rust-version.workspace = true
description = "Command line application to manage and query NLR's INFRA-COMPASS data"
homepage = "https://github.com/NREL/COMPASS"
repository = "https://github.com/NREL/COMPASS"
homepage = "https://github.com/NatLabRockies/COMPASS"
repository = "https://github.com/NatLabRockies/COMPASS"
license.workspace = true
categories.workspace = true
keywords.workspace = true
Expand Down
2 changes: 1 addition & 1 deletion crates/compass/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ authors.workspace = true
edition.workspace = true
rust-version.workspace = true
description = "Parse and manage the NLR's INFRA-COMPASS data"
homepage = "https://github.com/NREL/COMPASS"
homepage = "https://github.com/NatLabRockies/COMPASS"
repository.workspace = true
license.workspace = true
categories.workspace = true
Expand Down
8 changes: 4 additions & 4 deletions crates/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,27 +5,27 @@
### Windows (x86_64)

``` shell
Invoke-WebRequest -Uri 'https://github.com/NREL/NREL-ordinance-DB/releases/latest/download/nrel-ordinance-cli-x86_64-pc-windows-msvc.exe' -OutFile ordinance
Invoke-WebRequest -Uri 'https://github.com/NatLabRockies/COMPASS/releases/latest/download/infra-compass-cli-x86_64-pc-windows-msvc.exe' -OutFile ordinance
```

### MacOS (Apple Silicon)

``` shell
curl -o ordinance -L https://github.com/NREL/NREL-ordinance-DB/releases/latest/download/nrel-ordinance-cli-aarch64-apple-darwin
curl -o ordinance -L https://github.com/NatLabRockies/COMPASS/releases/latest/download/infra-compass-cli-aarch64-apple-darwin
chmod +x ordinance
```

### MacOS (Intel)

``` shell
curl -o ordinance -L https://github.com/NREL/NREL-ordinance-DB/releases/latest/download/nrel-ordinance-cli-x86_64-apple-darwin
curl -o ordinance -L https://github.com/NatLabRockies/COMPASS/releases/latest/download/infra-compass-cli-x86_64-apple-darwin
chmod +x ordinance
```

### Linux (x86_64)

``` shell
curl -o ordinance -L https://github.com/NREL/NREL-ordinance-DB/releases/latest/download/nrel-ordinance-cli-x86_64-unknown-linux-gnu
curl -o ordinance -L https://github.com/NatLabRockies/COMPASS/releases/latest/download/infra-compass-cli-x86_64-unknown-linux-gnu
chmod +x ordinance
```

2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@
]

intersphinx_mapping = {
"elm": ("https://nrel.github.io/elm", None),
"elm": ("https://natlabrockies.github.io/elm", None),
"lc": ("https://reference.langchain.com/python/", None),
"matplotlib": ("https://matplotlib.org/stable", None),
"networkx": ("https://networkx.org/documentation/stable", None),
Expand Down
8 changes: 4 additions & 4 deletions docs/source/dev/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ learn how to `create a branch <https://docs.github.com/en/pull-requests/collabor
and `request a review <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review>`_.

If you are not sure where or how to start contributing to COMPASS, consider reaching out to the
current developer(s): **Paul Pinchuk** ["ppinchuk@nrel.gov"] or **Guilherme Pimenta Castelao** ["gpimenta@nrel.gov"].
current developer(s): **Paul Pinchuk** ["ppinchuk@nlr.gov"] or **Guilherme Pimenta Castelao** ["gpimenta@nlr.gov"].

When you are ready to contribute to COMPASS, clone a copy of the COMPASS repository from GitHub, check out your
own branch, and make the appropriate changes locally. Ensure that your new code adheres to all of the guidelines
Expand Down Expand Up @@ -389,7 +389,7 @@ When you are ready to release a new version of COMPASS, please follow these step
8) Once the release is published and the tag has been created, you need to manually update the pixi lockfile:

a) Check out a new branch (e.g., ``update-lockfile-vX.Y.Z``)
b) Run ``pixi update nrel-compass`` to update the lockfile with the new COMPASS version
b) Run ``pixi update infra-compass`` to update the lockfile with the new COMPASS version
c) If needed, run ``pixi reinstall`` or ``pixi reinstall -e pdev`` to ensure the environment is consistent
d) Commit the updated ``pixi.lock`` file
e) Push your branch and open a PR with a title like "Update pixi lockfile for vX.Y.Z release"
Expand All @@ -398,14 +398,14 @@ When you are ready to release a new version of COMPASS, please follow these step

Congratulations, you have just released a new version of COMPASS!

You may want to verify that the release has been published to `PyPi <https://pypi.org/project/NREL-COMPASS/>`_
You may want to verify that the release has been published to `PyPi <https://pypi.org/project/INFRA-COMPASS/>`_
(if not, check the "Upload to PyPi" GitHub Action).


Copilot
^^^^^^^
This repo hosts a custom set of instructions for GitHub Copilot to help it write
code aligned with COMPASS best practices. You can check out these instructions
`here <https://github.com/NREL/COMPASS/blob/main/.github/copilot-instructions.md>`_
`here <https://github.com/NatLabRockies/COMPASS/blob/main/.github/copilot-instructions.md>`_
(they may help your as well!). If you have any suggestions on how to improve these
instructions, please open a PR!
8 changes: 4 additions & 4 deletions docs/source/misc/INSTALL.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ Installing from PyPI
--------------------

INFRA-COMPASS can be installed via pip from
`PyPI <https://pypi.org/project/NREL-COMPASS>`__.
`PyPI <https://pypi.org/project/INFRA-COMPASS>`__.

.. code-block:: shell

pip install nrel-compass
pip install infra-compass

.. note::

Expand Down Expand Up @@ -57,8 +57,8 @@ results.

Start by cloning the ``COMPASS`` repository:

- Using ssh: :code:`git clone git@github.com:NREL/COMPASS.git`
- Using https: :code:`git clone https://github.com/NREL/COMPASS.git`
- Using ssh: :code:`git clone git@github.com:NatLabRockies/COMPASS.git`
- Using https: :code:`git clone https://github.com/NatLabRockies/COMPASS.git`

If you don't already have ``pixi`` installed on your system, follow the (simple) `installation
instructions <https://pixi.sh/latest/#installation>`_.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/val/validation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ This validation effort is meant primarily as a sanity check and as a stepping st
Info
^^^^

- **COMPASS Version**: `v0.5.0 <https://github.com/NREL/COMPASS/releases/tag/v0.5.0>`_
- **COMPASS Version**: `v0.5.0 <https://github.com/NatLabRockies/COMPASS/releases/tag/v0.5.0>`_
- **Number of Documents**: 19 (Assuming 6,000 jurisdictions, there is a 95% chance that the metrics are within ±22.45% of the reported value)
- **Features**:

Expand Down
2 changes: 1 addition & 1 deletion examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ This directory contains several examples/tutorials to help you get started with
file for structured solar ordinance values.

For rendered versions of these guides, see the
[online documentation](https://nrel.github.io/COMPASS/examples/index.html).
[online documentation](https://natlabrockies.github.io/COMPASS/examples/index.html).
14 changes: 7 additions & 7 deletions examples/execution_basics/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Setting Up the Run Configuration
================================
The INFRA-COMPASS configuration file—written in either ``JSON`` or ``JSON5`` format—is a simple config that
defines parameters for running the process. Each key in the config corresponds to an argument for the function
`process_jurisdictions_with_openai <https://nrel.github.io/COMPASS/_autosummary/compass.scripts.process.process_jurisdictions_with_openai.html#compass.scripts.process.process_jurisdictions_with_openai>`_.
`process_jurisdictions_with_openai <https://natlabrockies.github.io/COMPASS/_autosummary/compass.scripts.process.process_jurisdictions_with_openai.html#compass.scripts.process.process_jurisdictions_with_openai>`_.
Refer to the linked documentation for detailed and up-to-date descriptions of each input.


Expand All @@ -35,10 +35,10 @@ Minimal Config
At a minimum, the INFRA-COMPASS config file requires three keys: ``"out_dir"``, ``"jurisdiction_fp"``, and ``"tech"``.

- ``out_dir``: Path to the output directory. Will be created if it does not exist.
- ``jurisdiction_fp``: Path to a CSV file containing ``County`` and ``State`` columns. Each row defines a jurisdiction to process. See the `example CSV <https://github.com/NREL/COMPASS/blob/main/examples/execution_basics/jurisdictions.csv>`_.
- ``jurisdiction_fp``: Path to a CSV file containing ``County`` and ``State`` columns. Each row defines a jurisdiction to process. See the `example CSV <https://github.com/NatLabRockies/COMPASS/blob/main/examples/execution_basics/jurisdictions.csv>`_.
- ``tech``: A string representing the infrastructure or technology focus for the run.

In `config_bare_minimum.json5 <https://github.com/NREL/COMPASS/blob/main/examples/execution_basics/config_bare_minimum.json5>`_,
In `config_bare_minimum.json5 <https://github.com/NatLabRockies/COMPASS/blob/main/examples/execution_basics/config_bare_minimum.json5>`_,
we show a minimal working configuration that includes only the required keys.

.. literalinclude:: config_bare_minimum.json5
Expand Down Expand Up @@ -68,9 +68,9 @@ Typical Config
--------------
In most cases, you'll want more control over the execution parameters, especially those related to the LLM configuration.
You can review all available inputs in the
`process_jurisdictions_with_openai <https://nrel.github.io/COMPASS/_autosummary/compass.scripts.process.process_jurisdictions_with_openai.html#compass.scripts.process.process_jurisdictions_with_openai>`_
`process_jurisdictions_with_openai <https://natlabrockies.github.io/COMPASS/_autosummary/compass.scripts.process.process_jurisdictions_with_openai.html#compass.scripts.process.process_jurisdictions_with_openai>`_
documentation.
In `config_recommended.json5 <https://github.com/NREL/COMPASS/blob/main/examples/execution_basics/config_recommended.json5>`_, we
In `config_recommended.json5 <https://github.com/NatLabRockies/COMPASS/blob/main/examples/execution_basics/config_recommended.json5>`_, we
demonstrate a typical configuration that balances simplicity with additional control over execution parameters.

.. literalinclude:: config_recommended.json5
Expand Down Expand Up @@ -112,7 +112,7 @@ Omit the ``pytesseract_exe_fp`` key to disable OCR functionality.
Kitchen Sink Config
-------------------

In `config_kitchen_sink.json5 <https://github.com/NREL/COMPASS/blob/main/examples/execution_basics/config_recommended.json5>`_,
In `config_kitchen_sink.json5 <https://github.com/NatLabRockies/COMPASS/blob/main/examples/execution_basics/config_recommended.json5>`_,
we show what a configuration might look like that utilizes all available parameters.

.. literalinclude:: config_kitchen_sink.json5
Expand Down Expand Up @@ -216,4 +216,4 @@ After completion, you'll find several outputs in the ``out_dir``:
- **Logs and Debug Files**: Helpful for reviewing LLM prompts and tracing any issues.

You can now use these outputs for downstream analysis, visualization, or integration with other NLR tools like
`reVX setbacks <https://nrel.github.io/reVX/misc/examples.setbacks.html>`_.
`reVX setbacks <https://natlabrockies.github.io/reVX/misc/examples.setbacks.html>`_.
4 changes: 2 additions & 2 deletions examples/parse_existing_docs/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ and convert it into structured values. By the end, you'll have a fully working s
both a text file of the ordinance and a structured CSV.

If you're only looking to download documents without extracting content, you may want to look at the
`ELM tutorial <https://github.com/NREL/elm/tree/main/examples/web_information_retrieval>`_,
`ELM tutorial <https://github.com/NatLabRockies/elm/tree/main/examples/web_information_retrieval>`_,
which focuses on scraping and saving documents alone.


Expand Down Expand Up @@ -238,7 +238,7 @@ one file. We also include additional logging setup so you can see the progress i
:language: python

You can also view this script in the repository:
`parse_pdf.py <https://github.com/NREL/COMPASS/blob/main/examples/parse_existing_docs/parse_pdf.py>`_
`parse_pdf.py <https://github.com/NatLabRockies/COMPASS/blob/main/examples/parse_existing_docs/parse_pdf.py>`_

.. _running:

Expand Down
Loading
Loading