Metadata-Version: 2.4
Name: reVReports
Version: 1.1.0
Summary: For creating standardized graphics to summarize/report outputs from reV supply curves.
Author-email: Michael Gleason <mike.gleason@nrel.gov>
Maintainer-email: Pavlo Pinchuk <ppinchuk@nrel.gov>
License-Expression: BSD-3-Clause
Project-URL: homepage, https://github.com/NREL/reVReports
Project-URL: documentation, https://nrel.github.io/reVReports/
Project-URL: repository, https://github.com/NREL/reVReports
Keywords: reVReports,NREL,Supply Curve,Visualization,Graphics
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.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: cartopy<0.25,>=0.24
Requires-Dist: click<9,>=8.1.7
Requires-Dist: geopandas<1.1,>=1.0.1
Requires-Dist: geoplot<1,>=0.5.1
Requires-Dist: imagehash<5,>=4.3.2
Requires-Dist: matplotlib<4.0,>=3.8.1
Requires-Dist: numpy<3,>=2.0.2
Requires-Dist: pandas<3.0,>=2.1.2
Requires-Dist: pydantic<3.0,>=2.4.2
Requires-Dist: pyproj<4,>=3.3.0
Requires-Dist: seaborn<1.0,>=0.13.0
Requires-Dist: shapely<3,>=2.0.7
Requires-Dist: tabulate<1.0,>=0.9.0
Requires-Dist: tqdm<5.0,>=4.66.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.14,>=0.13.3; 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<9,>=8.3.3; extra == "test"
Requires-Dist: pytest-cases<4,>=3.8.6; extra == "test"
Requires-Dist: pytest-cov<7,>=6.0.0; extra == "test"
Requires-Dist: pytest-mock<4,>=3.14.0; extra == "test"
Requires-Dist: pytest-profiling<2,>=1.7.0; extra == "test"
Requires-Dist: pytest-xdist<4,>=3.6.1; extra == "test"
Requires-Dist: snakeviz<3,>=2.2.2; extra == "test"
Requires-Dist: tox<5,>=4.23.2; 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"
Requires-Dist: twine<7,>=6.1.0; extra == "build"
Dynamic: license-file

**********
reVReports
**********

|License| |Ruff| |Pixi| |SWR|

.. |PythonV| image:: https://badge.fury.io/py/NREL-COMPASS.svg
    :target: https://pypi.org/project/NREL-COMPASS/

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

.. |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--29_-blue?label=NREL
    :alt: Static Badge

.. |Zenodo| image:: https://zenodo.org/badge/892830182.svg
    :target: https://doi.org/10.5281/zenodo.17173409

.. inclusion-intro


reVReports is a tool that aims  to make it very simple to create standard,
report-quality graphics that summarize the key results from multiple scenarios
of reV supply curves.


Installing reVReports
=====================
The quickest way to install reVReports for users is from PyPi:

.. code-block:: bash

    pip install revreports

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

.. code-block:: bash

    git clone git@github.com:NREL/reVReports.git; cd reVReports
    pixi run reVReports

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


Quickstart
==========
To run a quick reVReports demo, use:

.. code-block:: shell

    pixi run geo-demo

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

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


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