**********************************************
Welcome to The REsource eXtraction (rex) tool!
**********************************************
|Docs| |Tests| |Linter| |PyPi| |PythonV| |Conda| |Licence| |CodeCov| |Zeonodo|
.. |Docs| image:: https://github.com/NREL/rex/workflows/Documentation/badge.svg
:target: https://nrel.github.io/rex/
.. |Tests| image:: https://github.com/NREL/rex/workflows/Pytests/badge.svg
:target: https://github.com/NREL/rex/actions?query=workflow%3A%22Pytests%22
.. |Linter| image:: https://github.com/NREL/rex/workflows/Lint%20Code%20Base/badge.svg
:target: https://github.com/NREL/rex/actions?query=workflow%3A%22Lint+Code+Base%22
.. |PyPi| image:: https://img.shields.io/pypi/pyversions/NREL-rex.svg
:target: https://pypi.org/project/NREL-rex/
.. |PythonV| image:: https://badge.fury.io/py/NREL-rex.svg
:target: https://badge.fury.io/py/NREL-rex
.. |Conda| image:: https://anaconda.org/nrel/nrel-rex/badges/version.svg
:target: https://anaconda.org/nrel/nrel-rex
.. |Licence| image:: https://anaconda.org/nrel/nrel-rex/badges/license.svg
:target: https://anaconda.org/nrel/nrel-rex
.. |CodeCov| image:: https://codecov.io/gh/nrel/rex/branch/main/graph/badge.svg?token=WQ95L11SRS
:target: https://codecov.io/gh/nrel/rex
.. |Zeonodo| image:: https://zenodo.org/badge/253541811.svg
:target: https://zenodo.org/badge/latestdoi/253541811
.. inclusion-intro
rex command line tools
======================
- `rex <https://nrel.github.io/rex/_cli/rex.html#rex>`_
- `NSRDBX <https://nrel.github.io/rex/_cli/NSRDBX.html#NSRDBX>`_
- `WINDX <https://nrel.github.io/rex/_cli/WINDX.html#WINDX>`_
- `US-wave <https://nrel.github.io/rex/_cli/US-wave.html#US-wave>`_
- `WaveX <https://nrel.github.io/rex/_cli/WaveX.html#Wavex>`_
- `MultiYearX <https://nrel.github.io/rex/_cli/MultiYearX.html#MultiYearX>`_
- `rechunk <https://nrel.github.io/rex/_cli/rechunk.html#rechunk>`_
- `temporal-stats <https://nrel.github.io/rex/_cli/temporal-stats.html#temporal-stats>`_
- `wind-rose <https://nrel.github.io/rex/_cli/wind-rose.html#wind-rose>`_
Using Eagle Env
===============
If you would like to run `rex` on Eagle (NREL's HPC) you can use a pre-compiled
conda env:
.. code-block:: bash
conda activate /shared-projects/rev/modulefiles/conda/envs/rev/
or
.. code-block:: bash
source activate /shared-projects/rev/modulefiles/conda/envs/rev/
Installing rex
==============
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.
Option 1: Install from PIP or Conda (recommended for analysts):
---------------------------------------------------------------
1. Create a new environment:
``conda create --name rex``
2. Activate directory:
``conda activate rex``
3. Install rex:
1) ``pip install NREL-rex`` or
2) ``conda install nrel-rex --channel=nrel``
- NOTE: If you install using conda and want to use `HSDS <https://github.com/NREL/hsds-examples>`_
you will also need to install h5pyd manually: ``pip install h5pyd``
Option 2: Clone repo (recommended for developers)
-------------------------------------------------
1. from home dir, ``git clone git@github.com:NREL/rex.git``
2. Create ``rex`` environment and install package
1) Create a conda env: ``conda create -n rex``
2) Run the command: ``conda activate rex``
3) cd into the repo cloned in 1.
4) prior to running ``pip`` below, make sure the branch is correct (install
from main!)
5) Install ``rex`` and its dependencies by running:
``pip install .`` (or ``pip install -e .`` if running a dev branch
or working on the source code)
3. Check that ``rex`` was installed successfully
1) From any directory, run the following commands. This should return the
help pages for the CLI's.
- ``rex``
- ``NSRDBX``
- ``WINDX``
- ``US-wave``
Recommended Citation
====================
Update with current version and DOI:
Michael Rossol, Grant Buster. The REsource Extraction Tool (rex).
https://github.com/NREL/rex (version v0.2.43), 2021.
https://doi.org/10.5281/zenodo.4499033.
Raw data
{
"_id": null,
"home_page": "https://nrel.github.io/rex/",
"name": "NREL-rex",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "rex",
"author": "Michael Rossol",
"author_email": "michael.rossol@nrel.gov",
"download_url": "https://files.pythonhosted.org/packages/7b/8f/9770c4f069695e28f5b4e551f34eff0845df4c0d19c9c969fd8debf1845b/NREL-rex-0.2.91.tar.gz",
"platform": null,
"description": "**********************************************\nWelcome to The REsource eXtraction (rex) tool!\n**********************************************\n\n|Docs| |Tests| |Linter| |PyPi| |PythonV| |Conda| |Licence| |CodeCov| |Zeonodo|\n\n.. |Docs| image:: https://github.com/NREL/rex/workflows/Documentation/badge.svg\n :target: https://nrel.github.io/rex/\n\n.. |Tests| image:: https://github.com/NREL/rex/workflows/Pytests/badge.svg\n :target: https://github.com/NREL/rex/actions?query=workflow%3A%22Pytests%22\n\n.. |Linter| image:: https://github.com/NREL/rex/workflows/Lint%20Code%20Base/badge.svg\n :target: https://github.com/NREL/rex/actions?query=workflow%3A%22Lint+Code+Base%22\n\n.. |PyPi| image:: https://img.shields.io/pypi/pyversions/NREL-rex.svg\n :target: https://pypi.org/project/NREL-rex/\n\n.. |PythonV| image:: https://badge.fury.io/py/NREL-rex.svg\n :target: https://badge.fury.io/py/NREL-rex\n\n.. |Conda| image:: https://anaconda.org/nrel/nrel-rex/badges/version.svg\n :target: https://anaconda.org/nrel/nrel-rex\n\n.. |Licence| image:: https://anaconda.org/nrel/nrel-rex/badges/license.svg\n :target: https://anaconda.org/nrel/nrel-rex\n\n.. |CodeCov| image:: https://codecov.io/gh/nrel/rex/branch/main/graph/badge.svg?token=WQ95L11SRS\n :target: https://codecov.io/gh/nrel/rex\n\n.. |Zeonodo| image:: https://zenodo.org/badge/253541811.svg\n :target: https://zenodo.org/badge/latestdoi/253541811\n\n.. inclusion-intro\n\nrex command line tools\n======================\n\n- `rex <https://nrel.github.io/rex/_cli/rex.html#rex>`_\n- `NSRDBX <https://nrel.github.io/rex/_cli/NSRDBX.html#NSRDBX>`_\n- `WINDX <https://nrel.github.io/rex/_cli/WINDX.html#WINDX>`_\n- `US-wave <https://nrel.github.io/rex/_cli/US-wave.html#US-wave>`_\n- `WaveX <https://nrel.github.io/rex/_cli/WaveX.html#Wavex>`_\n- `MultiYearX <https://nrel.github.io/rex/_cli/MultiYearX.html#MultiYearX>`_\n- `rechunk <https://nrel.github.io/rex/_cli/rechunk.html#rechunk>`_\n- `temporal-stats <https://nrel.github.io/rex/_cli/temporal-stats.html#temporal-stats>`_\n- `wind-rose <https://nrel.github.io/rex/_cli/wind-rose.html#wind-rose>`_\n\nUsing Eagle Env\n===============\n\nIf you would like to run `rex` on Eagle (NREL's HPC) you can use a pre-compiled\nconda env:\n\n.. code-block:: bash\n\n conda activate /shared-projects/rev/modulefiles/conda/envs/rev/\n\nor\n\n.. code-block:: bash\n\n source activate /shared-projects/rev/modulefiles/conda/envs/rev/\n\nInstalling rex\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\nOption 1: Install from PIP or Conda (recommended for analysts):\n---------------------------------------------------------------\n\n1. Create a new environment:\n ``conda create --name rex``\n\n2. Activate directory:\n ``conda activate rex``\n\n3. Install rex:\n 1) ``pip install NREL-rex`` or\n 2) ``conda install nrel-rex --channel=nrel``\n\n - NOTE: If you install using conda and want to use `HSDS <https://github.com/NREL/hsds-examples>`_\n you will also need to install h5pyd manually: ``pip install h5pyd``\n\nOption 2: Clone repo (recommended for developers)\n-------------------------------------------------\n\n1. from home dir, ``git clone git@github.com:NREL/rex.git``\n\n2. Create ``rex`` environment and install package\n 1) Create a conda env: ``conda create -n rex``\n 2) Run the command: ``conda activate rex``\n 3) cd into the repo cloned in 1.\n 4) prior to running ``pip`` below, make sure the branch is correct (install\n from main!)\n 5) Install ``rex`` and its dependencies by running:\n ``pip install .`` (or ``pip install -e .`` if running a dev branch\n or working on the source code)\n\n3. Check that ``rex`` was installed successfully\n 1) From any directory, run the following commands. This should return the\n help pages for the CLI's.\n\n - ``rex``\n - ``NSRDBX``\n - ``WINDX``\n - ``US-wave``\n\nRecommended Citation\n====================\n\nUpdate with current version and DOI:\n\nMichael Rossol, Grant Buster. The REsource Extraction Tool (rex).\nhttps://github.com/NREL/rex (version v0.2.43), 2021.\nhttps://doi.org/10.5281/zenodo.4499033.\n\n\n",
"bugtrack_url": null,
"license": "BSD 3-Clause",
"summary": "National Renewable Energy Laboratory's (NREL's) REsource eXtraction tool: rex",
"version": "0.2.91",
"project_urls": {
"Homepage": "https://nrel.github.io/rex/"
},
"split_keywords": [
"rex"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "88119ec15e3ae9ba387b70d0d19576778582aa3af3f6a3f9002cf05ad9c2e47e",
"md5": "42150bf5ec1bab03c778243c584be6da",
"sha256": "13f94f691b83e3d98d0b6b647fd4dfcec8c865b859516da7db37e3925384e4e7"
},
"downloads": -1,
"filename": "NREL_rex-0.2.91-py3-none-any.whl",
"has_sig": false,
"md5_digest": "42150bf5ec1bab03c778243c584be6da",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 161207,
"upload_time": "2024-11-04T22:17:13",
"upload_time_iso_8601": "2024-11-04T22:17:13.261536Z",
"url": "https://files.pythonhosted.org/packages/88/11/9ec15e3ae9ba387b70d0d19576778582aa3af3f6a3f9002cf05ad9c2e47e/NREL_rex-0.2.91-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7b8f9770c4f069695e28f5b4e551f34eff0845df4c0d19c9c969fd8debf1845b",
"md5": "e52a2f7758fb07f8c8e773f0276a80c9",
"sha256": "afdf1cfad6efbde0e521aa2e3143bc4f25ed2fbb9df4d4ba3fa7342a3580381a"
},
"downloads": -1,
"filename": "NREL-rex-0.2.91.tar.gz",
"has_sig": false,
"md5_digest": "e52a2f7758fb07f8c8e773f0276a80c9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 134826,
"upload_time": "2024-11-04T22:17:15",
"upload_time_iso_8601": "2024-11-04T22:17:15.195417Z",
"url": "https://files.pythonhosted.org/packages/7b/8f/9770c4f069695e28f5b4e551f34eff0845df4c0d19c9c969fd8debf1845b/NREL-rex-0.2.91.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-04 22:17:15",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "nrel-rex"
}
JSON