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
4 changes: 2 additions & 2 deletions .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/gaps/releases/latest) of GAPs.
[latest version](https://github.com/NatLabRockies/gaps/releases/latest) of GAPs.
required: true
- label: >
I have confirmed this bug exists on the main branch of GAPs.
Expand Down Expand Up @@ -72,4 +72,4 @@ body:
attributes:
label: Charge code
placeholder: >
If you are at NREL and fixing this bug is urgent, please provide a charge code
If you are at NLR and fixing this bug is urgent, please provide a charge code
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
blank_issues_enabled: true
contact_links:
- name: Question
url: https://github.com/NREL/reV/discussions
url: https://github.com/NatLabRockies/reV/discussions
about: |
Ask questions about the reV suite (including GAPs) and discuss with
the developers and other users here. If you have a question like "How
Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/documentation_improvement.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ 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/gaps/)
on `main` [here](https://natlabrockies.github.io/gaps/)
required: true
- type: textarea
id: location
Expand All @@ -19,8 +19,8 @@ body:
description: >
Please provide the location of the documentation, e.g. ``gaps.config.load_config`` or the
URL of the documentation, e.g.
"https://nrel.github.io/gaps/_autosummary/gaps.config.load_config.html#gaps.config.load_config"
placeholder: https://nrel.github.io/gaps/_autosummary/gaps.config.load_config.html#gaps.config.load_config
"https://natlabrockies.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/feature_request.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,4 @@ body:
attributes:
label: Charge code
placeholder: >
If you are at NREL and implementing this feature is urgent, please provide a charge code
If you are at NLR and implementing this feature is urgent, please provide a charge code
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/gaps/misc/installation.html).
I have read the [installation guide](https://natlabrockies.github.io/gaps/misc/installation.html).
required: true
- type: input
id: platform
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/apptainer-build-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ jobs:
steps:

- name: Check out code for the container builds
uses: actions/checkout@v6
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

- name: Build Container
run: |
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/codecov.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
name: Codecov
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
ref: ${{ github.event.pull_request.head.ref || github.ref }}
fetch-depth: 1
Expand All @@ -31,7 +31,7 @@ jobs:
uses: codecov/codecov-action@v5
with:
token: ${{ secrets.CODECOV_TOKEN }}
file: ./coverage.xml
files: ./coverage.xml
flags: unittests
env_vars: OS,PYTHON
name: codecov-umbrella
Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,23 +14,23 @@ jobs:

steps:
- name: Pull Repo
uses: actions/checkout@v6
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
fetch-depth: 0
fetch-tags: true

- uses: prefix-dev/setup-pixi@v0.9.3
- uses: prefix-dev/setup-pixi@v0.9.4
with:
pixi-version: v0.50.2
pixi-version: v0.62.2
locked: true
cache: true
cache-write: ${{ github.ref == 'refs/heads/main' }}
environments: dev

- name: Build Docs
run: |
pixi reinstall -e dev NREL-gaps
pixi run -e dev make-html
pixi reinstall -e dev NLR-GAPs
pixi run -e dev python-docs

- name: deploy
uses: peaceiris/actions-gh-pages@v4.0.0
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/linter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
name: Lint Code Base with Ruff
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
- uses: astral-sh/ruff-action@v3
with:
version: "latest"
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/pixi_tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,18 @@ jobs:

steps:
- name: Checkout Repo
uses: actions/checkout@v6
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
fetch-depth: 0

- uses: prefix-dev/setup-pixi@v0.9.3
- uses: prefix-dev/setup-pixi@v0.9.4
with:
pixi-version: v0.50.2
pixi-version: v0.62.2
locked: true
cache: true
cache-write: ${{ github.ref == 'refs/heads/main' }}
environments: dev

- run: |
pixi reinstall -e dev NREL-gaps
pixi reinstall -e dev NLR-GAPs
pixi run -e dev tests
6 changes: 3 additions & 3 deletions .github/workflows/pr_rev_cli_tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: checkout gaps
uses: actions/checkout@v6
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
ref: ${{ github.event.pull_request.head.ref }}
fetch-depth: 1
path: gaps
- name: checkout reV
uses: actions/checkout@v6
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
repository: nrel/reV
repository: NatLabRockies/reV
fetch-depth: 1
path: reV
- name: Set up Python
Expand Down
24 changes: 14 additions & 10 deletions .github/workflows/publish_to_pypi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,29 @@ on:
jobs:
deploy:
name: Build and upload wheels
permissions:
# IMPORTANT: write permission is mandatory for Trusted Publishing
id-token: write
contents: read
runs-on: ubuntu-latest
if: startsWith(github.ref, 'refs/tags/v')

steps:
- uses: actions/checkout@v6
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
fetch-depth: 0
fetch-tags: true

- uses: prefix-dev/setup-pixi@v0.9.3
- uses: prefix-dev/setup-pixi@v0.9.4
with:
pixi-version: v0.50.2
pixi-version: v0.62.2
locked: true
cache: true
cache-write: ${{ github.ref == 'refs/heads/main' }}
environments: dev

- name: Build and publish
env:
TWINE_USERNAME: __token__
TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
run: |
pixi reinstall -e dev NREL-gaps
pixi run -e dev upload-wheels
- name: Build
run: pixi run -e dev build-wheels

- name: Publish package distributions to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
2 changes: 1 addition & 1 deletion .github/workflows/super_linter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:

steps:
- name: Checkout Code
uses: actions/checkout@v6
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
# super-linter needs the full git history to get the
# list of files that changed across commits
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/tests_tox.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
python-version: ['3.13', '3.12', '3.11', '3.10', '3.9']

steps:
- uses: actions/checkout@v6
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
fetch-depth: 0

Expand Down Expand Up @@ -64,7 +64,7 @@ jobs:
os: [ubuntu-latest, macos-latest]

steps:
- uses: actions/checkout@v6
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
fetch-depth: 0

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/wildows_pytests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
python-version: ['3.10', 3.11, 3.12, 3.13]

steps:
- uses: actions/checkout@v6
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
ref: ${{ github.event.pull_request.head.ref }}
fetch-depth: 1
Expand Down
6 changes: 3 additions & 3 deletions Apptainer
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@ From: python:3.11

%labels
Author Paul Pinchuk
Maintainer ppinchuk@nrel.gov
URL https://github.com/NREL/gaps
Maintainer ppinchuk@nlr.gov
URL https://github.com/NatLabRockies/gaps

%post
echo "Installing vim"
apt-get update && apt-get -y upgrade
apt-get -y --allow-unauthenticated install vim git wget nano make

echo "Downloading GAPs"
git clone https://github.com/NREL/gaps.git
git clone https://github.com/NatLabRockies/gaps.git

echo "Installing GAPs..."
cd gaps
Expand Down
8 changes: 4 additions & 4 deletions INSTALL.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ Installing from PyPI
~~~~~~~~~~~~~~~~~~~~

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

.. code-block:: shell

pip install nrel-gaps
pip install nlr-gaps

.. note::
You must have ``pip>=19.3`` to install from PyPI.
Expand Down Expand Up @@ -51,8 +51,8 @@ or `miniconda <https://www.anaconda.com/docs/getting-started/miniconda/main>`__
package/environment manager.

1. Clone the `gaps` repository.
- Using ssh: :code:`git clone git@github.com:NREL/gaps.git`
- Using https: :code:`git clone https://github.com/NREL/gaps.git`
- Using ssh: :code:`git clone git@github.com:NatLabRockies/gaps.git`
- Using https: :code:`git clone https://github.com/NatLabRockies/gaps.git`

2. Create and activate the ``gaps`` environment and install the package:
1) Create a conda env: ``conda create -n gaps python=3.13``
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
BSD 3-Clause License

Copyright (c) 2023, Alliance for Sustainable Energy, LLC
Copyright (c) 2026, Alliance for Energy Innovation, LLC

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
Expand Down
44 changes: 22 additions & 22 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,23 @@ Welcome to Geospatial Analysis Pipelines (GAPs)!
|PyPi| |PythonV| |Ruff| |Pixi|
|License| |SWR|

.. |Docs| image:: https://github.com/NREL/gaps/workflows/Documentation/badge.svg
:target: https://nrel.github.io/gaps/
.. |Docs| image:: https://github.com/NatLabRockies/gaps/workflows/Documentation/badge.svg
:target: https://natlabrockies.github.io/gaps/

.. |Tests| image:: https://github.com/NREL/gaps/workflows/Pytests/badge.svg
:target: https://github.com/NREL/gaps/actions?query=workflow%3A%22Pytests%22
.. |Tests| image:: https://github.com/NatLabRockies/gaps/workflows/Pytests/badge.svg
:target: https://github.com/NatLabRockies/gaps/actions?query=workflow%3A%22Pytests%22

.. |Linter| image:: https://github.com/NREL/gaps/workflows/Lint%20Code%20Base/badge.svg
:target: https://github.com/NREL/gaps/actions?query=workflow%3A%22Lint+Code+Base%22
.. |Linter| image:: https://github.com/NatLabRockies/gaps/workflows/Lint%20Code%20Base/badge.svg
:target: https://github.com/NatLabRockies/gaps/actions?query=workflow%3A%22Lint+Code+Base%22

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

.. |PythonV| image:: https://badge.fury.io/py/NREL-gaps.svg
:target: https://badge.fury.io/py/NREL-gaps
.. |PythonV| image:: https://badge.fury.io/py/NLR-GAPs.svg
:target: https://badge.fury.io/py/NLR-GAPs

.. |Codecov| image:: https://codecov.io/gh/NREL/gaps/branch/main/graph/badge.svg?token=6VZK0Q2QNQ
:target: https://codecov.io/gh/NREL/gaps
.. |Codecov| image:: https://codecov.io/gh/NatLabRockies/gaps/branch/main/graph/badge.svg?token=6VZK0Q2QNQ
:target: https://codecov.io/gh/NatLabRockies/gaps

.. |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 All @@ -33,15 +33,15 @@ Welcome to Geospatial Analysis Pipelines (GAPs)!
.. |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--23--28_-blue?label=NREL
.. |SWR| image:: https://img.shields.io/badge/SWR--23--28_-blue?label=NLR
:alt: Static Badge

.. inclusion-intro

Geospatial Analysis Pipelines (GAPs) is a framework designed
to assist researchers and software developers add execution
tools to their geospatial python models. Born from the
open-source `reV <https://github.com/NREL/reV>`_ model, GAPs is a
open-source `reV <https://github.com/NatLabRockies/reV>`_ model, GAPs is a
robust and easy-to-use engine that provides a rich set of features
such as command-line interface (CLI) generation and documentation,
basic High-Performance Computing (HPC) scaling capabilities,
Expand All @@ -57,19 +57,19 @@ use GAPs to add a variety of utility for end-users, including a complete
set of CLI commands and documentation pulled from the model run function
docstrings. In addition, GAPs provides basic HPC execution capabilities,
particularly catered towards embarrassingly parallel geospatial models
(e.g. single-location models such as the `System Advisor Model <https://sam.nrel.gov>`_).
(e.g. single-location models such as the `System Advisor Model <https://sam.nlr.gov>`_).
GAPs can automatically distribute the execution of such models over a large
geospatial extent (e.g. CONUS) across many parallel HPC nodes.

GAPs is **NOT** a workflow management system (WMS), and therefore does not
provide any of the in-depth tools/capabilities expected from a proper WMS.
However, GAPs-supported models can sometimes be included as part of the workflow in
WMS tools like `Torc <https://pages.github.nrel.gov/viz/wms/index.html#/>`_.
WMS tools like `Torc <https://pages.github.natlabrockies.gov/viz/wms/index.html#/>`_.

To get started, take a look at the examples for
`analysts <https://nrel.github.io/gaps/misc/examples.users.html>`_ or
`model developers <https://nrel.github.io/gaps/misc/examples.developers.html>`_
or dive straight into the full `documentation <https://nrel.github.io/gaps/>`_.
`analysts <https://natlabrockies.github.io/gaps/misc/examples.users.html>`_ or
`model developers <https://natlabrockies.github.io/gaps/misc/examples.developers.html>`_
or dive straight into the full `documentation <https://natlabrockies.github.io/gaps/>`_.


Installing GAPs
Expand All @@ -79,19 +79,19 @@ The quickest way to install GAPs for users is from PyPi:

.. code-block:: shell

pip install nrel-gaps
pip install nlr-gaps

If you are a developer contributing to GAPs, we recommend using `pixi <https://pixi.sh/latest/>`_:

.. code-block:: shell

pixi shell

For detailed instructions, see the `installation documentation <https://nrel.github.io/gaps/misc/installation.html>`_.
For detailed instructions, see the `installation documentation <https://natlabrockies.github.io/gaps/misc/installation.html>`_.

Development
===========
Please see the `Development Guidelines <https://nrel.github.io/gaps/dev/index.html>`_
Please see the `Development Guidelines <https://natlabrockies.github.io/gaps/dev/index.html>`_
if you wish to contribute code to this repository.


Expand Down
Loading
Loading