| Name | NREL-reVX JSON |
| Version |
0.3.60
JSON |
| download |
| home_page | https://nrel.github.io/reVX/ |
| Summary | National Renewable Energy Laboratory's (NREL's) Renewable Energy Potential(V) eXchange Tool: reVX |
| upload_time | 2024-09-23 21:30:13 |
| maintainer | None |
| docs_url | None |
| author | Michael Rossol |
| requires_python | >=3.8 |
| license | BSD 3-Clause |
| keywords |
revx
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
************************************************************************
Welcome to the `reV <https://nrel.github.io/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 <https://nrel.github.io/reVX/_cli/reVX.html#revx>`_
- `reV-rpm <https://nrel.github.io/reVX/_cli/reV-rpm.html#rev-rpm>`_
- `reV-plexos <https://nrel.github.io/reVX/_cli/reV-plexos.html>`_
- `plexos-plants <https://nrel.github.io/reVX/_cli/plexos-plants.html#plexos-plants>`_
- `mean-wind-dirs <https://nrel.github.io/reVX/_cli/mean-wind-dirs.html#mean-wind-dirs>`_
- `prominent-wind-dirs <https://nrel.github.io/reVX/_cli/prominent-wind-dirs.html#prominent-wind-dirs>`_
- `setbacks <https://nrel.github.io/reVX/_cli/setbacks.html#setbacks>`_
- `offshore-assembly-areas <https://nrel.github.io/reVX/_cli/offshore-assembly-areas.html#offshore-assembly-areas>`_
- `offshore-dist-to-ports <https://nrel.github.io/reVX/_cli/offshore-dist-to-ports.html#offshore-dist-to-ports>`_
- `offshore-inputs <https://nrel.github.io/reVX/_cli/offshore-inputs.html#offshore-inputs>`_
Installing reVX
===============
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.
#. 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 <https://github.com/NREL/reVX/blob/main/.github/workflows/pull_request_tests.yml#L31-L34>`_. 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 <https://nrel.github.io/reVX/_cli/reVX.setbacks.setbacks.html>`_ you will need to install rtree manually:
* ``conda install rtree``
* `pip installation instructions <https://pypi.org/project/Rtree/#:~:text=Rtree%20is%20a%20ctypes%20Python,Multi%2Ddimensional%20indexes>`_
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.
Raw data
{
"_id": null,
"home_page": "https://nrel.github.io/reVX/",
"name": "NREL-reVX",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "reVX",
"author": "Michael Rossol",
"author_email": "michael.rossol@nrel.gov",
"download_url": "https://files.pythonhosted.org/packages/c4/e2/bb10937a575a86840bc074a0e2ca9eac7360edc06da5f84fde8c3e09d9b5/NREL-reVX-0.3.60.tar.gz",
"platform": null,
"description": "************************************************************************\nWelcome to the `reV <https://nrel.github.io/reV>`_ eXchange (reVX) tool!\n************************************************************************\n\n|Docs| |Tests| |Linter| |PythonV| |PyPi| |Codecov| |Zenondo|\n\n.. |Docs| image:: https://github.com/NREL/reVX/workflows/Documentation/badge.svg\n :target: https://nrel.github.io/reVX/\n\n.. |Tests| image:: https://github.com/NREL/reVX/actions/workflows/pull_request_tests.yml/badge.svg\n :target: https://github.com/NREL/reVX/actions?query=workflow%3A%22Pytests%22\n\n.. |Linter| image:: https://github.com/NREL/reVX/actions/workflows/linter.yml/badge.svg\n :target: https://github.com/NREL/reVX/actions?query=workflow%3A%22Lint+Code+Base%22\n\n.. |PythonV| image:: https://img.shields.io/pypi/pyversions/NREL-reVX.svg\n :target: https://pypi.org/project/NREL-reVX/\n\n.. |PyPi| image:: https://badge.fury.io/py/NREL-reVX.svg\n :target: https://badge.fury.io/py/NREL-reVX\n\n.. |Codecov| image:: https://codecov.io/gh/nrel/reVX/branch/main/graph/badge.svg?token=3J5M44VAA9\n :target: https://codecov.io/gh/nrel/reVX\n\n.. |Zenondo| image:: https://zenodo.org/badge/201337735.svg\n :target: https://zenodo.org/badge/latestdoi/201337735\n\n.. inclusion-intro\n\nreVX command line tools\n=======================\n\n- `reVX <https://nrel.github.io/reVX/_cli/reVX.html#revx>`_\n- `reV-rpm <https://nrel.github.io/reVX/_cli/reV-rpm.html#rev-rpm>`_\n- `reV-plexos <https://nrel.github.io/reVX/_cli/reV-plexos.html>`_\n- `plexos-plants <https://nrel.github.io/reVX/_cli/plexos-plants.html#plexos-plants>`_\n- `mean-wind-dirs <https://nrel.github.io/reVX/_cli/mean-wind-dirs.html#mean-wind-dirs>`_\n- `prominent-wind-dirs <https://nrel.github.io/reVX/_cli/prominent-wind-dirs.html#prominent-wind-dirs>`_\n- `setbacks <https://nrel.github.io/reVX/_cli/setbacks.html#setbacks>`_\n- `offshore-assembly-areas <https://nrel.github.io/reVX/_cli/offshore-assembly-areas.html#offshore-assembly-areas>`_\n- `offshore-dist-to-ports <https://nrel.github.io/reVX/_cli/offshore-dist-to-ports.html#offshore-dist-to-ports>`_\n- `offshore-inputs <https://nrel.github.io/reVX/_cli/offshore-inputs.html#offshore-inputs>`_\n\nInstalling reVX\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#. Create a new environment:\n ``conda create --name revx python=3.8``\n\n#. Activate your new environment:\n ``conda activate revx``\n\n#. Clone the repo:\n 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``\n\n#. Install reVX:\n 1) Follow the installation commands installation process that we use for our automated test suite `here <https://github.com/NREL/reVX/blob/main/.github/workflows/pull_request_tests.yml#L31-L34>`_. Make sure that you call ``pip install -e .`` from within the cloned repository directory e.g. ``/home/{user}/reVX/``\n\n - NOTE: If you install using pip and want to run `exclusion setbacks <https://nrel.github.io/reVX/_cli/reVX.setbacks.setbacks.html>`_ you will need to install rtree manually:\n * ``conda install rtree``\n * `pip installation instructions <https://pypi.org/project/Rtree/#:~:text=Rtree%20is%20a%20ctypes%20Python,Multi%2Ddimensional%20indexes>`_\n\nRecommended Citation\n====================\n\nUpdate with current version and DOI:\n\nMichael Rossol, Grant Buster, and Robert Spencer. The Renewable Energy\nPotential(V) eXchange Tool: reVX. https://github.com/NREL/reVX\n(version v0.3.20), 2021. https://doi.org/10.5281/zenodo.4507580.\n\n\n",
"bugtrack_url": null,
"license": "BSD 3-Clause",
"summary": "National Renewable Energy Laboratory's (NREL's) Renewable Energy Potential(V) eXchange Tool: reVX",
"version": "0.3.60",
"project_urls": {
"Homepage": "https://nrel.github.io/reVX/"
},
"split_keywords": [
"revx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "05d8f211f5d83f39585e4bd4e303b3ca2ca2b2b06fd363623d0a71800b2f467f",
"md5": "6c86277b7359df525bf4ed315400626a",
"sha256": "06d942dd5bfced46f0b09988ece370fa6af400486916b0d7088f4aafb1ebab4e"
},
"downloads": -1,
"filename": "NREL_reVX-0.3.60-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6c86277b7359df525bf4ed315400626a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 290182,
"upload_time": "2024-09-23T21:30:12",
"upload_time_iso_8601": "2024-09-23T21:30:12.329278Z",
"url": "https://files.pythonhosted.org/packages/05/d8/f211f5d83f39585e4bd4e303b3ca2ca2b2b06fd363623d0a71800b2f467f/NREL_reVX-0.3.60-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c4e2bb10937a575a86840bc074a0e2ca9eac7360edc06da5f84fde8c3e09d9b5",
"md5": "c4e15268cea9606f3dd0232cc310e91d",
"sha256": "0c4bf29aaf4230a761c4f5044010ffb51efa8cbe81071e58918a7f8f974f3f30"
},
"downloads": -1,
"filename": "NREL-reVX-0.3.60.tar.gz",
"has_sig": false,
"md5_digest": "c4e15268cea9606f3dd0232cc310e91d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 235251,
"upload_time": "2024-09-23T21:30:13",
"upload_time_iso_8601": "2024-09-23T21:30:13.921461Z",
"url": "https://files.pythonhosted.org/packages/c4/e2/bb10937a575a86840bc074a0e2ca9eac7360edc06da5f84fde8c3e09d9b5/NREL-reVX-0.3.60.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-23 21:30:13",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "nrel-revx"
}
