Metadata-Version: 2.1
Name: NREL-gaps
Version: 0.3.2
Summary: National Renewable Energy Laboratory's (NREL's) Geospatial Analysis Pipelines (GAPs) framework
Home-page: https://nrel.github.io/gaps/
Author: Paul Pinchuk
Maintainer-email: ppinchuk@nrel.gov
License: BSD 3-Clause
Keywords: gaps
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
License-File: LICENSE
Requires-Dist: click (>=8.1.3)
Requires-Dist: colorama (>=0.4.6)
Requires-Dist: NREL-rex (>=0.2.80)
Requires-Dist: numpy (>=1.24.2)
Requires-Dist: numpydoc (>=1.5.0)
Requires-Dist: pandas (>=2.0.0)
Requires-Dist: psutil (>=5.9.2)
Requires-Dist: setuptools (>=65.4.0)
Requires-Dist: sphinx (>=5.3.0)
Requires-Dist: sphinx-copybutton (>=0.5.1)
Requires-Dist: sphinx-click (>=4.4.0)
Requires-Dist: sphinx-tabs (>=3.4.1)
Requires-Dist: tabulate (>=0.9.0)
Provides-Extra: dev
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: h5py ; extra == 'dev'
Requires-Dist: black ; extra == 'dev'
Requires-Dist: pylint ; extra == 'dev'
Requires-Dist: jupyter ; extra == 'dev'
Requires-Dist: pipreqs ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: pytest ; extra == 'docs'
Requires-Dist: pytest-cov ; extra == 'docs'
Requires-Dist: h5py ; extra == 'docs'
Requires-Dist: black ; extra == 'docs'
Requires-Dist: pylint ; extra == 'docs'
Requires-Dist: jupyter ; extra == 'docs'
Requires-Dist: pipreqs ; extra == 'docs'
Requires-Dist: make ; extra == 'docs'
Requires-Dist: ghp-import ; extra == 'docs'
Requires-Dist: numpydoc ; extra == 'docs'
Requires-Dist: pandoc ; extra == 'docs'
Provides-Extra: test
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'
Requires-Dist: h5py ; extra == 'test'

================================================
Welcome to Geospatial Analysis Pipelines (GAPs)!
================================================

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

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

.. 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

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

.. image:: https://badge.fury.io/py/NREL-gaps.svg
    :target: https://badge.fury.io/py/NREL-gaps

.. image:: https://codecov.io/gh/NREL/gaps/branch/main/graph/badge.svg?token=6VZK0Q2QNQ
    :target: https://codecov.io/gh/NREL/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.


To get started, take a look at the `documentation <https://nrel.github.io/gaps/>`_ (examples coming soon!)


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.


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`


2. Create and activate  the ``gaps`` environment and install the package:
    1) Create a conda env: ``conda create -n gaps python=3.10``
    2) Activate the newly-created conda env: ``conda activate gaps``
    3) Change directories into the repository: ``cd gaps``
    4) Prior to running ``pip`` below, make sure the branch is correct (install from main!): ``git branch -vv``
    5) Install ``gaps`` and its dependencies by running:
       ``pip install -e .`` (or ``pip install -e .[dev]`` if running a dev branch or working on the source code)



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.


Acknowledgments
===============
.. inclusion-ack

Paul Pinchuk and Grant Buster. Geospatial Analysis Pipelines. 2023. https://doi.org/10.11578/dc.20230426.7

The authors of this code would like to thank ExxonMobil Corporation for their contributions to this effort.
