Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

reVX

Renewable Energy Potential(V) eXchange Toot.
https://github.com/NatLabRockies/reVX

Category: Energy Systems
Sub Category: Renewable Energy Integration

Keywords from Contributors

renewable-energy solar-energy climate-data nrel climate-change generative-adversarial-network wind-energy downscaling reanalysis severe-weather

Last synced: about 2 hours ago
JSON representation

Repository metadata

The reV eXchange Tool: reVX

README.rst 

          ************************************************************************
Welcome to the `reV `_ eXchange (reVX) tool!
************************************************************************

|Docs| |Tests| |Linter| |PythonV| |PyPi| |Codecov| |Zenondo|

.. |Docs| image:: https://github.com/NREL/reVX/workflows/Documentation/badge.svg
    :target: https://nrel.github.io/reVX/

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

.. |Linter| image:: https://github.com/NREL/reVX/workflows/Lint%20Code%20Base/badge.svg
    :target: https://github.com/NREL/reVX/actions?query=workflow%3A%22Lint+Code+Base%22

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

.. |PyPi| image:: https://badge.fury.io/py/NREL-reVX.svg
    :target: https://badge.fury.io/py/NREL-reVX

.. |Codecov| image:: https://codecov.io/gh/nrel/reVX/branch/main/graph/badge.svg?token=3J5M44VAA9
    :target: https://codecov.io/gh/nrel/reVX

.. |Zenondo| image:: https://zenodo.org/badge/201337735.svg
   :target: https://zenodo.org/badge/latestdoi/201337735

.. inclusion-intro

reVX command line tools
=======================

- `reVX `_
- `reV-rpm `_
- `reV-plexos `_
- `plexos-plants `_
- `mean-wind-dirs `_
- `prominent-wind-dirs `_
- `setbacks `_
- `offshore-assembly-areas `_
- `offshore-dist-to-ports `_
- `offshore-inputs `_

Installing reVX
===============

NOTE: The installation instruction below assume that you have python installed
on your machine and are using `conda `_
as your package/environment manager.

#. Create a new environment:
    ``conda create --name revx python=3.8``

#. Activate your new environment:
    ``conda activate revx``

#. Clone the repo:
    From your home directory ``/home/{user}/`` or another directory that you have permissions in, run the command ``git clone git@github.com:NREL/reVX.git`` and then go into your cloned repository: ``cd reVX``

#. Install reVX:
    1) Follow the installation commands installation process that we use for our automated test suite `here `_. Make sure that you call ``pip install -e .`` from within the cloned repository directory e.g. ``/home/{user}/reVX/``

        - NOTE: If you install using pip and want to run `exclusion setbacks `_ you will need to install rtree manually:
            * ``conda install rtree``
            * `pip installation instructions `_

Recommended Citation
====================

Update with current version and DOI:

Michael Rossol, Grant Buster, and Robert Spencer. The Renewable Energy
Potential(V) eXchange Tool: reVX. https://github.com/NREL/reVX
(version v0.3.20), 2021. https://doi.org/10.5281/zenodo.4507580.

Owner metadata

GitHub Events

Total
Last Year

Issue and Pull Request metadata

Last synced: 4 months ago

Total issues: 80
Total pull requests: 203
Average time to close issues: about 2 months
Average time to close pull requests: 8 days
Total issue authors: 12
Total pull request authors: 10
Average comments per issue: 2.73
Average comments per pull request: 1.19
Merged pull request: 187
Bot issues: 0
Bot pull requests: 0

Past year issues: 17
Past year pull requests: 28
Past year average time to close issues: 2 months
Past year average time to close pull requests: about 20 hours
Past year issue authors: 4
Past year pull request authors: 1
Past year average comments per issue: 0.18
Past year average comments per pull request: 0.79
Past year merged pull request: 24
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/NatLabRockies/reVX

Top Issue Authors

  • MRossol (25)
  • ppinchuk (16)
  • mmowers (11)
  • grantbuster (7)
  • alopez04 (6)
  • WilliamsTravis (6)
  • mikebannis (2)
  • EvanRosenliebNREL (2)
  • mjgleason (2)
  • nickwg03 (1)
  • Sidrcs (1)
  • netr0m (1)

Top Pull Request Authors

  • ppinchuk (79)
  • MRossol (63)
  • grantbuster (33)
  • mikebannis (15)
  • pesap (4)
  • WilliamsTravis (3)
  • mjgleason (2)
  • RSpencer019 (2)
  • bnb32 (1)
  • mmowers (1)

Top Issue Labels

  • feature (30)
  • bug (27)
  • enhancement (8)
  • p-high (6)
  • wishlist (4)
  • p-medium (4)
  • dependencies (3)
  • chore (3)
  • topic-transmission (3)
  • topic-handlers (2)
  • topic-plexos (2)
  • topic-offshore (1)
  • good first issue (1)
  • documentation (1)
  • refactor (1)
  • topic-setbacks (1)
  • new computation (1)

Top Pull Request Labels

  • feature (39)
  • refactor (22)
  • bug (18)
  • enhancement (12)
  • dependencies (8)
  • p-high (8)
  • topic-transmission (5)
  • chore (4)
  • deprecation (2)
  • p-low (2)
  • topic-handlers (2)
  • documentation (2)
  • p-medium (2)
  • bugfix (2)

Dependencies

.github/workflows/codecov.yml actions
  • actions/checkout v2 composite
  • codecov/codecov-action v1 composite
  • conda-incubator/setup-miniconda v2 composite
.github/workflows/gh-pages.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • peaceiris/actions-gh-pages v3.6.1 composite
.github/workflows/linter.yml actions
  • actions/checkout v2 composite
  • docker://ghcr.io/github/super-linter slim-v4 composite
.github/workflows/publish_to_pypi.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
.github/workflows/pull_request_tests.yml actions
  • actions/checkout v2 composite
  • codecov/codecov-action v1 composite
  • conda-incubator/setup-miniconda v2 composite
.github/workflows/release_drafter.yml actions
  • release-drafter/release-drafter v5.15.0 composite
Dockerfile docker
  • continuumio/miniconda3 latest build
docs/requirements.txt pypi
  • ghp-import *
  • sphinx *
  • sphinx-click *
  • sphinx_rtd_theme *
docker-compose.yml docker
pyproject.toml pypi
  • NREL-gaps >=0.7.0,<0.8
  • NREL-reV >=0.12.1,<0.13
  • NREL-rex >=0.2.99,<0.3
  • addfips >=0.4.2,<0.5
  • dask >=2024.8.0,<2025
  • fiona ~=1.9.0
  • geopandas >=0.14.4,<0.15
  • numpy <2.0.0
  • psycopg2-binary >=2.9.10,<3
  • pydantic >=2.10.6,<3
  • pyogrio ~=0.5.1
  • pyproj ~=3.5.0
  • pywavelets >=1.5,<1.6
  • rasterio ~=1.3.11
  • scikit-image ~=0.21.0
  • scikit-learn >=1.6.1,<2
  • shapely ~=1.8.5
  • toolz >=1.0.0,<2
.github/workflows/pull_request_flicker_tests.yml actions
  • actions/checkout v4 composite
  • conda-incubator/setup-miniconda v2 composite

Score: -Infinity