Data

Tools

Indexes

Applications

Experiments

Open Source Science

reVX

The Renewable Energy Potential(V) eXchange Tool: reVX

https://github.com/NREL/reVX

Science Score: 49.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 2 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.3%) to scientific vocabulary

Keywords from Contributors

solar-energy nrel climate-change climate-data downscaling generative-adversarial-network reanalysis renewable-energy severe-weather urban-heat-island
Last synced: 6 months ago · JSON representation

Repository

The Renewable Energy Potential(V) eXchange Tool: reVX

Basic Info
Statistics
  • Stars: 26
  • Watchers: 6
  • Forks: 17
  • Open Issues: 14
  • Releases: 72
Created over 6 years ago · Last pushed 7 months ago
Metadata Files
Readme License

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/actions/workflows/pull_request_tests.yml/badge.svg
    :target: https://github.com/NREL/reVX/actions?query=workflow%3A%22Pytests%22

.. |Linter| image:: https://github.com/NREL/reVX/actions/workflows/linter.yml/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.11``

#. 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 --no-build-isolation -e .`` from within the cloned repository directory e.g. ``/home/{user}/reVX/``. Don't forget to run ``pip install --upgrade setuptools``, especially if you run into any build errors.

        - 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 `_
        - NOTE: If you install using pip and want to run shadow flicker exclusions, make sure you:
            * Use Python 3.10 or 3.11: ``conda create --name revx python=3.11``
            * Install the ``flicker`` dependency: ``pip install -e .[flicker]``

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

  • Name: National Renewable Energy Laboratory
  • Login: NREL
  • Kind: organization
  • Location: Golden, CO

GitHub Events

Total
  • Create event: 17
  • Release event: 5
  • Issues event: 22
  • Watch event: 4
  • Delete event: 9
  • Issue comment event: 16
  • Push event: 104
  • Pull request event: 26
  • Pull request review event: 4
  • Pull request review comment event: 4
  • Fork event: 9
Last Year
  • Create event: 17
  • Release event: 5
  • Issues event: 22
  • Watch event: 4
  • Delete event: 9
  • Issue comment event: 16
  • Push event: 104
  • Pull request event: 26
  • Pull request review event: 4
  • Pull request review comment event: 4
  • Fork event: 9

Committers

Last synced: 10 months ago

All Time
  • Total Commits: 2,019
  • Total Committers: 11
  • Avg Commits per committer: 183.545
  • Development Distribution Score (DDS): 0.559
Past Year
  • Commits: 211
  • Committers: 3
  • Avg Commits per committer: 70.333
  • Development Distribution Score (DDS): 0.062
Top Committers
Name Email Commits
Michael Rossol m****l@g****m 890
ppinchuk p****k@n****v 707
grantbuster g****r@n****v 244
mbannist m****r@n****v 144
Rob Spencer r****r@n****v 14
bnb32 b****n@n****v 7
pesap p****z@n****v 5
WilliamsTravis t****s@n****v 4
psanchez p****z@n****v 2
Mike Gleason m****o@g****m 1
Matthew Mowers m****s@e****v 1
Committer Domains (Top 20 + Academic)
nrel.gov: 7 el3.ib0.cm.hpc.nrel.gov: 1 nerl.gov: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 81
  • Total pull requests: 185
  • Average time to close issues: about 2 months
  • Average time to close pull requests: 7 days
  • Total issue authors: 12
  • Total pull request authors: 10
  • Average comments per issue: 2.69
  • Average comments per pull request: 1.18
  • Merged pull requests: 172
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 17
  • Pull requests: 29
  • Average time to close issues: about 2 months
  • Average time to close pull requests: about 20 hours
  • Issue authors: 4
  • Pull request authors: 1
  • Average comments per issue: 0.12
  • Average comments per pull request: 0.79
  • Merged pull requests: 25
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
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)
Pull Request Authors
  • ppinchuk (78)
  • MRossol (63)
  • grantbuster (33)
  • mikebannis (15)
  • pesap (4)
  • WilliamsTravis (3)
  • mjgleason (2)
  • RSpencer019 (2)
  • bnb32 (1)
  • mmowers (1)
Top Labels
Issue Labels
feature (30) bug (27) enhancement (8) p-high (6) wishlist (4) p-medium (4) topic-transmission (4) chore (3) dependencies (3) documentation (2) topic-plexos (2) topic-handlers (2) refactor (1) topic-offshore (1) good first issue (1) new computation (1)
Pull Request Labels
feature (39) refactor (22) bug (18) enhancement (12) dependencies (8) p-high (7) topic-transmission (5) chore (4) deprecation (2) p-low (2) topic-handlers (2) documentation (2) p-medium (2) bugfix (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 154 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 69
  • Total maintainers: 4
pypi.org: nrel-revx

National Renewable Energy Laboratory's (NREL's) Renewable Energy Potential(V) eXchange Tool: reVX

  • Versions: 69
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 154 Last month
Rankings
Dependent packages count: 7.3%
Forks count: 12.6%
Average: 14.4%
Downloads: 14.6%
Stargazers count: 15.6%
Dependent repos count: 22.1%
Maintainers (4)
bnb32 grantbuster-nrel mrossol_nrel ppinchuk-nrel
Last synced: 6 months ago

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