| Name | NREL-gaps JSON |
| Version |
0.6.14
JSON |
| download |
| home_page | https://nrel.github.io/gaps/ |
| Summary | National Renewable Energy Laboratory's (NREL's) Geospatial Analysis Pipelines (GAPs) framework |
| upload_time | 2024-08-19 21:25:34 |
| maintainer | None |
| docs_url | None |
| author | Paul Pinchuk |
| requires_python | None |
| license | BSD 3-Clause |
| keywords |
gaps
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
================================================
Welcome to Geospatial Analysis Pipelines (GAPs)!
================================================
|Docs| |Tests| |Linter| |PyPi| |PythonV| |Codecov|
.. |Docs| image:: https://github.com/NREL/gaps/workflows/Documentation/badge.svg
:target: https://nrel.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
.. |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
.. |PyPi| image:: https://img.shields.io/pypi/pyversions/NREL-gaps.svg
:target: https://pypi.org/project/NREL-gaps/
.. |PythonV| image:: https://badge.fury.io/py/NREL-gaps.svg
:target: https://badge.fury.io/py/NREL-gaps
.. |Codecov| 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 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
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,
configuration file generation, job status monitoring, and more.
Who should use GAPs
===================
GAPs is intended to be used by researchers and/or software developers
who have implemented a working python model but have not yet added any
external model execution tools. Within minimal effort, developers can
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>`_).
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#/>`_.
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/>`_.
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.
Raw data
{
"_id": null,
"home_page": "https://nrel.github.io/gaps/",
"name": "NREL-gaps",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": "ppinchuk@nrel.gov",
"keywords": "gaps",
"author": "Paul Pinchuk",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/ac/b3/992c61acc6067ebf849caef2279ebf60a54203d80736bf60f427a73be28f/NREL-gaps-0.6.14.tar.gz",
"platform": null,
"description": "================================================\nWelcome to Geospatial Analysis Pipelines (GAPs)!\n================================================\n\n|Docs| |Tests| |Linter| |PyPi| |PythonV| |Codecov|\n\n.. |Docs| image:: https://github.com/NREL/gaps/workflows/Documentation/badge.svg\n :target: https://nrel.github.io/gaps/\n\n.. |Tests| image:: https://github.com/NREL/gaps/workflows/Pytests/badge.svg\n :target: https://github.com/NREL/gaps/actions?query=workflow%3A%22Pytests%22\n\n.. |Linter| image:: https://github.com/NREL/gaps/workflows/Lint%20Code%20Base/badge.svg\n :target: https://github.com/NREL/gaps/actions?query=workflow%3A%22Lint+Code+Base%22\n\n.. |PyPi| image:: https://img.shields.io/pypi/pyversions/NREL-gaps.svg\n :target: https://pypi.org/project/NREL-gaps/\n\n.. |PythonV| image:: https://badge.fury.io/py/NREL-gaps.svg\n :target: https://badge.fury.io/py/NREL-gaps\n\n.. |Codecov| image:: https://codecov.io/gh/NREL/gaps/branch/main/graph/badge.svg?token=6VZK0Q2QNQ\n :target: https://codecov.io/gh/NREL/gaps\n\n\n.. inclusion-intro\n\nGeospatial Analysis Pipelines (GAPs) is a framework designed\nto assist researchers and software developers add execution\ntools to their geospatial python models. Born from the\nopen-source `reV <https://github.com/NREL/reV>`_ model, GAPs is a\nrobust and easy-to-use engine that provides a rich set of features\nsuch as command-line interface (CLI) generation and documentation,\nbasic High-Performance Computing (HPC) scaling capabilities,\nconfiguration file generation, job status monitoring, and more.\n\n\nWho should use GAPs\n===================\nGAPs is intended to be used by researchers and/or software developers\nwho have implemented a working python model but have not yet added any\nexternal model execution tools. Within minimal effort, developers can\nuse GAPs to add a variety of utility for end-users, including a complete\nset of CLI commands and documentation pulled from the model run function\ndocstrings. In addition, GAPs provides basic HPC execution capabilities,\nparticularly catered towards embarrassingly parallel geospatial models\n(e.g. single-location models such as the `System Advisor Model <https://sam.nrel.gov>`_).\nGAPs can automatically distribute the execution of such models over a large\ngeospatial extent (e.g. CONUS) across many parallel HPC nodes.\n\nGAPs is **NOT** a workflow management system (WMS), and therefore does not\nprovide any of the in-depth tools/capabilities expected from a proper WMS.\nHowever, GAPs-supported models can sometimes be included as part of the workflow in\nWMS tools like `Torc <https://pages.github.nrel.gov/viz/wms/index.html#/>`_.\n\nTo get started, take a look at the examples for\n`analysts <https://nrel.github.io/gaps/misc/examples.users.html>`_ or\n`model developers <https://nrel.github.io/gaps/misc/examples.developers.html>`_\nor dive straight into the full `documentation <https://nrel.github.io/gaps/>`_.\n\n\nInstalling GAPs\n===============\n\nNOTE: The installation instruction below assume that you have python installed\non your machine and are using `conda <https://docs.conda.io/en/latest/index.html>`_\nas your package/environment manager.\n\n\n1. Clone the `gaps` repository.\n - Using ssh: :code:`git clone git@github.com:NREL/gaps.git`\n - Using https: :code:`git clone https://github.com/NREL/gaps.git`\n\n\n2. Create and activate the ``gaps`` environment and install the package:\n 1) Create a conda env: ``conda create -n gaps python=3.10``\n 2) Activate the newly-created conda env: ``conda activate gaps``\n 3) Change directories into the repository: ``cd gaps``\n 4) Prior to running ``pip`` below, make sure the branch is correct (install from main!): ``git branch -vv``\n 5) Install ``gaps`` and its dependencies by running:\n ``pip install -e .`` (or ``pip install -e .[dev]`` if running a dev branch or working on the source code)\n\n\n\nDevelopment\n===========\n\nThis repository uses `pylint <https://pylint.pycqa.org/en/latest/>`_ to lint the code and\n`black <https://black.readthedocs.io/en/stable/index.html>`_ to format it (check out the\n`black formatting style <https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html>`_).\nIf you wish to contribute to this repository, your code will have to adhere to both of these guidelines and pass all existing tests.\n\n\nAcknowledgments\n===============\n.. inclusion-ack\n\nPaul Pinchuk and Grant Buster. Geospatial Analysis Pipelines. 2023. https://doi.org/10.11578/dc.20230426.7\n\nThe authors of this code would like to thank ExxonMobil Corporation for their contributions to this effort.\n",
"bugtrack_url": null,
"license": "BSD 3-Clause",
"summary": "National Renewable Energy Laboratory's (NREL's) Geospatial Analysis Pipelines (GAPs) framework",
"version": "0.6.14",
"project_urls": {
"Homepage": "https://nrel.github.io/gaps/"
},
"split_keywords": [
"gaps"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b051a025e1b9fbe459fa45eef37abc6602a16e20979cba77b723bbea2dccc203",
"md5": "51964d2d07ee0a859f14aee6670143eb",
"sha256": "47b5a57608cd515cab90af410952be59b443c520375d438fce05c70a0ea554fd"
},
"downloads": -1,
"filename": "NREL_gaps-0.6.14-py3-none-any.whl",
"has_sig": false,
"md5_digest": "51964d2d07ee0a859f14aee6670143eb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 92860,
"upload_time": "2024-08-19T21:25:32",
"upload_time_iso_8601": "2024-08-19T21:25:32.905415Z",
"url": "https://files.pythonhosted.org/packages/b0/51/a025e1b9fbe459fa45eef37abc6602a16e20979cba77b723bbea2dccc203/NREL_gaps-0.6.14-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "acb3992c61acc6067ebf849caef2279ebf60a54203d80736bf60f427a73be28f",
"md5": "5009a5775d08e7ae70ef645d4b913b45",
"sha256": "0f69cdccd4c1f7418b6f5348426b160883c37ab45db7e3f950210704bdf696e3"
},
"downloads": -1,
"filename": "NREL-gaps-0.6.14.tar.gz",
"has_sig": false,
"md5_digest": "5009a5775d08e7ae70ef645d4b913b45",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 79610,
"upload_time": "2024-08-19T21:25:34",
"upload_time_iso_8601": "2024-08-19T21:25:34.192068Z",
"url": "https://files.pythonhosted.org/packages/ac/b3/992c61acc6067ebf849caef2279ebf60a54203d80736bf60f427a73be28f/NREL-gaps-0.6.14.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-19 21:25:34",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "nrel-gaps"
}
