National Renewable Energy Laboratory's (NREL's) Geospatial Analysis Pipelines (GAPs) framework
Project description
================================================ Welcome to Geospatial Analysis Pipelines (GAPs)!
.. inclusion-intro
Geospatial Analysis Pipelines (GAPs) is a framework designed
to assist users in scaling their geospatial models to a
High-Performance Computing (HPC) environment. In particular,
GAPs automatically distributes the execution of a
single-location model (such as the System Advisor Model <https://sam.nrel.gov>
)
over a large geospatial extent (e.g. CONUS) across many parallel
HPC nodes. Born from the open-source reV <https://github.com/NREL/reV>
model, GAPs is a
robust and easy-to-use engine that provides a rich set of features
such as configuration file generation, job status monitoring,
CLI Documentation, and more.
Installing gaps
NOTE: The installation instruction below assume that you have python installed
on your machine and are using conda <https://docs.conda.io/en/latest/index.html>
_
as your package/environment manager.
-
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:
-
Create and activate the
gaps
environment and install the package:- Create a conda env:
conda create -n gaps python=3.10
- Activate the newly-created conda env:
conda activate gaps
- Change directories into the repository:
cd gaps
- Prior to running
pip
below, make sure the branch is correct (install from main!):git branch -vv
- Install
gaps
and its dependencies by running:pip install -e .
(orpip install -e .[dev]
if running a dev branch or working on the source code)
- Create a conda env:
Development
This repository uses pylint <https://pylint.pycqa.org/en/latest/>
_ to lint the code and
black <https://black.readthedocs.io/en/stable/index.html>
_ to format it (check out the
black formatting style <https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html>
_).
If you wish to contribute to this repository, your code will have to adhere to both of these guidelines and pass all existing tests.
Authors
Paul Pinchuk, Grant Buster
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for NREL_gaps-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b049bda8e641b1d117048f3d8c6b3e3f3be4f1e3d3387dafcd904a775fb434dc |
|
MD5 | de6d9fd9e9e8a3214e7ecd5280054af6 |
|
BLAKE2b-256 | 8b630d8c4c391825916e62cfe1f4ad1374bd5f28b3d8abf45726676161896880 |