Metadata-Version: 2.4
Name: NLR-reVeal
Version: 0.2.3
Summary: The reV Extension for Analyzing Large Loads.
Author-email: Michael Gleason <mike.gleason@nlr.gov>
Maintainer-email: Pavlo Pinchuk <ppinchuk@nlr.gov>
License-Expression: BSD-3-Clause
Project-URL: homepage, https://github.com/NatLabRockies/reVeal
Project-URL: documentation, https://natlabrockies.github.io/reVeal/
Project-URL: repository, https://github.com/NatLabRockies/reVeal
Keywords: reVeal,NLR,Load Analysis,Geospatial,Site-Suitability
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Requires-Python: >=3.12
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: exactextract<0.4,>=0.3.0
Requires-Dist: geopandas<2,>=1.1.1
Requires-Dist: gdal<4,>=3.10.3
Requires-Dist: libpysal<5,>=4.13.0
Requires-Dist: NLR-GAPs<1,>=0.9.1
Requires-Dist: NLR-rex<1,>=0.5.0
Requires-Dist: pandas<3,>=2.3.3
Requires-Dist: pyarrow<23,>=22.0.0
Requires-Dist: pydantic<3,>=2.12.5
Requires-Dist: pyogrio<0.13,>=0.12.1
Requires-Dist: rasterio<2,>=1.4.4
Requires-Dist: tqdm<5,>=4.67.1
Provides-Extra: dev
Requires-Dist: jupyter<1.1,>=1.0.0; extra == "dev"
Requires-Dist: pipreqs<0.5,>=0.4.13; extra == "dev"
Requires-Dist: ruff<0.15,>=0.14.5; extra == "dev"
Requires-Dist: ruff-lsp<0.0.63,>=0.0.62; extra == "dev"
Provides-Extra: test
Requires-Dist: flaky<4,>=3.8.1; extra == "test"
Requires-Dist: pytest<10,>=9.0.1; extra == "test"
Requires-Dist: pytest-cases<4,>=3.9.1; extra == "test"
Requires-Dist: pytest-cov<8,>=7.0.0; extra == "test"
Requires-Dist: pytest-mock<4,>=3.15.1; extra == "test"
Requires-Dist: pytest-profiling<2,>=1.8.1; extra == "test"
Requires-Dist: pytest-xdist<4,>=3.8.0; extra == "test"
Requires-Dist: snakeviz<3,>=2.2.2; extra == "test"
Requires-Dist: tox<5,>=4.32.0; extra == "test"
Provides-Extra: doc
Requires-Dist: ghp-import<3,>=2.1.0; extra == "doc"
Requires-Dist: pydata-sphinx-theme<0.17,>=0.16.1; extra == "doc"
Requires-Dist: sphinx-click<7,>=6.0.0; extra == "doc"
Requires-Dist: sphinx-copybutton<0.6,>=0.5.2; extra == "doc"
Requires-Dist: sphinx-tabs<4,>=3.4.1; extra == "doc"
Requires-Dist: sphinxcontrib-mermaid<2,>=1.0.0; extra == "doc"
Provides-Extra: build
Requires-Dist: build<2,>=1.2.2; extra == "build"
Requires-Dist: pkginfo<2,>=1.12.1.2; extra == "build"
Dynamic: license-file

******
reVeal
******

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

.. |PyPi| image:: https://badge.fury.io/py/NLR-reVeal.svg
    :target: https://pypi.org/project/NLR-reVeal/

.. |PythonV| image:: https://img.shields.io/pypi/pyversions/NLR-reVeal.svg
    :target: https://pypi.org/project/NLR-reVeal/

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

.. |License| image:: https://img.shields.io/badge/License-BSD_3--Clause-orange.svg
    :target: https://opensource.org/licenses/BSD-3-Clause

.. |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--25--147_-blue?label=NLR
    :alt: Static Badge

.. |Zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.17984036.svg
    :target: https://doi.org/10.5281/zenodo.17984036

.. |Codecov| image:: https://codecov.io/github/NatLabRockies/reVeal/graph/badge.svg?token=NXBPNUPT3Y
    :target: https://codecov.io/github/NatLabRockies/reVeal

.. inclusion-intro


``reVeal`` (the reV Extension for Analyzing Large Loads) is an open-source geospatial
software package for modeling the site-suitability and spatial patterns of deployment
of large sources of electricity demand under future scenarios. ``reVeal`` is part of
the `reV ecosystem of tools <https://natlabrockies.github.io/reV/#rev-ecosystem>`_.


Installing reVeal
=================
The quickest way to install reVeal for users is from PyPI:

.. code-block:: bash

    pip install NLR-reVeal

If you would like to install and run reVeal from source, we recommend using `pixi <https://pixi.sh/latest/>`_:

.. code-block:: bash

    git clone git@github.com:NatLabRockies/reVeal.git; cd reVeal
    pixi run reVeal

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


Quickstart
==========
.. To run a quick reVeal demo, use:

.. .. code-block:: shell

..     pixi run demo

.. This will generate sample map outputs using example reV geothermal supply curve outputs.

For more information on running ``reVeal``, see
`Usage <https://github.com/NatLabRockies/reVeal/blob/main/USAGE.md>`_.


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