Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ body:
required: true
- label: >
I have confirmed this bug exists on the
[latest version](https://github.com/NREL/rex/releases/latest) of rex.
[latest version](https://github.com/NatLabRockies/rex/releases/latest) of rex.
required: true
- label: >
I have confirmed this bug exists on the main branch of rex.
Expand Down Expand Up @@ -77,4 +77,4 @@ body:
attributes:
label: Charge code
placeholder: >
If you are at NREL and fixing this bug is urgent, please provide a charge code
If you are at NLR and fixing this bug is urgent, please provide a charge code
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
blank_issues_enabled: true
contact_links:
- name: Question
url: https://github.com/NREL/reV/discussions
url: https://github.com/NatLabRockies/reV/discussions
about: |
Ask questions about the reV suite (including rex) and discuss with the developers and other users
here. If you have a question like "How do I read data from the WTK?", please
Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/documentation_improvement.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ body:
options:
- label: >
I have checked that the issue still exists on the latest versions of the docs
on `main` [here](https://nrel.github.io/rex/)
on `main` [here](https://natlabrockies.github.io/rex/)
required: true
- type: textarea
id: location
Expand All @@ -19,8 +19,8 @@ body:
description: >
Please provide the location of the documentation, e.g. ``rex.resource.Resource`` or the
URL of the documentation, e.g.
"https://nrel.github.io/rex/_autosummary/rex.resource.Resource.html#rex.resource.Resource"
placeholder: https://nrel.github.io/rex/_autosummary/rex.resource.Resource.html#rex.resource.Resource
"https://natlabrockies.github.io/rex/_autosummary/rex.resource.Resource.html#rex.resource.Resource"
placeholder: https://natlabrockies.github.io/rex/_autosummary/rex.resource.Resource.html#rex.resource.Resource
validations:
required: true
- type: textarea
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,4 @@ body:
attributes:
label: Charge code
placeholder: >
If you are at NREL and implementing this feature is urgent, please provide a charge code
If you are at NLR and implementing this feature is urgent, please provide a charge code
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/installation_issue.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ body:
label: Installation check
options:
- label: >
I have read the [installation guide](https://nrel.github.io/rex/#installing-rex).
I have read the [installation guide](https://natlabrockies.github.io/rex/#installing-rex).
required: true
- type: input
id: platform
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/pr_rev_tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
- name: checkout reV
uses: actions/checkout@v3
with:
repository: nrel/reV
repository: NatLabRockies/reV
fetch-depth: 1
path: reV
- name: Set up Python
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/pr_revx_tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
- name: checkout reVX
uses: actions/checkout@v2
with:
repository: nrel/reVX
repository: NatLabRockies/reVX
fetch-depth: 1
path: reVX
- name: Set up Python
Expand Down
65 changes: 32 additions & 33 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,29 +4,29 @@ 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/
.. |Docs| image:: https://github.com/NatLabRockies/rex/workflows/Documentation/badge.svg
:target: https://natlabrockies.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
.. |Tests| image:: https://github.com/NatLabRockies/rex/workflows/Pytests/badge.svg
:target: https://github.com/NatLabRockies/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
.. |Linter| image:: https://github.com/NatLabRockies/rex/workflows/Lint%20Code%20Base/badge.svg
:target: https://github.com/NatLabRockies/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/
.. |PyPi| image:: https://img.shields.io/pypi/pyversions/NLR-rex.svg
:target: https://pypi.org/project/NLR-rex/

.. |PythonV| image:: https://badge.fury.io/py/NREL-rex.svg
:target: https://badge.fury.io/py/NREL-rex
.. |PythonV| image:: https://badge.fury.io/py/NLR-rex.svg
:target: https://badge.fury.io/py/NLR-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
.. |CodeCov| image:: https://codecov.io/gh/natlabrockies/rex/branch/main/graph/badge.svg?token=WQ95L11SRS
:target: https://codecov.io/gh/natlabrockies/rex

.. |Zeonodo| image:: https://zenodo.org/badge/253541811.svg
:target: https://zenodo.org/badge/latestdoi/253541811
Expand All @@ -38,20 +38,20 @@ What is rex?
``rex`` stands for **REsource eXtraciton** tool.

``rex`` enables the efficient and scalable extraction, manipulation, and
computation with NRELs flagship renewable resource datasets such as: the Wind
computation with NLRs flagship renewable resource datasets such as: the Wind
Integration National Dataset (WIND Toolkit), the National Solar Radiation
Database (NSRDB), the Ocean Surface Wave Hindcast (US Wave) Data, and the
High-resolution downscaled climate change data (Sup3rCC).

To get started accessing NREL's datasets, see the primer on `NREL Renewable
To get started accessing NLR's datasets, see the primer on `NLR Renewable
Energy Resource Data
<https://nrel.github.io/rex/misc/examples.nrel_data.html>`_ or the
`installation instructions <https://nrel.github.io/rex/#installing-rex>`_.
<https://natlabrockies.github.io/rex/misc/examples.nlr_data.html>`_ or the
`installation instructions <https://natlabrockies.github.io/rex/#installing-rex>`_.

You might also want to check out the basic `Resource Class
<https://nrel.github.io/rex/_autosummary/rex.resource.Resource.html>`_ that
can be used to efficiently query NREL data, or our various `example use cases
<https://nrel.github.io/rex/misc/examples.html>`_.
<https://natlabrockies.github.io/rex/_autosummary/rex.resource.Resource.html>`_ that
can be used to efficiently query NLR data, or our various `example use cases
<https://natlabrockies.github.io/rex/misc/examples.html>`_.

Installing rex
==============
Expand All @@ -70,16 +70,15 @@ Option 1: Install from PIP or Conda (recommended for analysts):
``conda activate rex``

3. Basic ``rex`` install:
1) ``pip install NREL-rex``
2) or ``conda install nrel-rex --channel=nrel``
``pip install NLR-rex``

4. Install for users outside of NREL that want to access data via HSDS or S3 as per the instructions `here <https://nrel.github.io/rex/misc/examples.nrel_data.html#data-location-external-users>`_:
1) ``pip install NREL-rex[hsds]`` for more performant access of the data on HSDS with slightly more setup as per `this hsds example <https://nrel.github.io/rex/misc/examples.hsds.html>`_. Note that the highest version of Python currently supported by ``hsds`` is Python 3.11.
4. Install for users outside of NLR that want to access data via HSDS or S3 as per the instructions `here <https://natlabrockies.github.io/rex/misc/examples.nlr_data.html#data-location-external-users>`_:
1) ``pip install NLR-rex[hsds]`` for more performant access of the data on HSDS with slightly more setup as per `this hsds example <https://natlabrockies.github.io/rex/misc/examples.hsds.html>`_. Note that the highest version of Python currently supported by ``hsds`` is Python 3.11.

Option 2: Clone repo (recommended for developers)
-------------------------------------------------

1. from home dir, ``git clone git@github.com:NREL/rex.git``
1. from home dir, ``git clone git@github.com:NatLabRockies/rex.git``

2. Create ``rex`` environment and install package
1) Create a conda env: ``conda create -n rex``
Expand All @@ -103,12 +102,12 @@ Option 2: Clone repo (recommended for developers)
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>`_
- `rex <https://natlabrockies.github.io/rex/_cli/rex.html#rex>`_
- `NSRDBX <https://natlabrockies.github.io/rex/_cli/NSRDBX.html#NSRDBX>`_
- `WINDX <https://natlabrockies.github.io/rex/_cli/WINDX.html#WINDX>`_
- `US-wave <https://natlabrockies.github.io/rex/_cli/US-wave.html#US-wave>`_
- `WaveX <https://natlabrockies.github.io/rex/_cli/WaveX.html#Wavex>`_
- `MultiYearX <https://natlabrockies.github.io/rex/_cli/MultiYearX.html#MultiYearX>`_
- `rechunk <https://natlabrockies.github.io/rex/_cli/rechunk.html#rechunk>`_
- `temporal-stats <https://natlabrockies.github.io/rex/_cli/temporal-stats.html#temporal-stats>`_
- `wind-rose <https://natlabrockies.github.io/rex/_cli/wind-rose.html#wind-rose>`_
2 changes: 1 addition & 1 deletion bin/rex-Conda-3
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ proc ModulesHelp { } {
puts stdout "Build: $PKG_NAME-$PKG_VERSION"
puts stdout "URL: "
puts stdout "Description: Resource Extraction Tool"
puts stdout "For assistance contact michael.rossol@nrel.gov"
puts stdout "For assistance contact michael.rossol@nlr.gov"
puts stdout " "
puts stdout "Note: "
puts stdout " "
Expand Down
8 changes: 4 additions & 4 deletions conda.recipe/meta.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
package:
name: nrel-rex
name: nlr-rex
version: {{ environ.get('GIT_DESCRIBE_TAG','').replace('v', '', 1) }}

source:
Expand Down Expand Up @@ -48,8 +48,8 @@ requirements:
- h5pyd

about:
home: "https://github.com/NREL/rex"
home: "https://github.com/NatLabRockies/rex"
license: BSD 3-Clause
summary: "REsource eXtraction (rex) tool"
doc_url: "https://nrel.github.io/rex"
dev_url: "https://github.com/NREL/rex"
doc_url: "https://natlabrockies.github.io/rex"
dev_url: "https://github.com/NatLabRockies/rex"
2 changes: 1 addition & 1 deletion conda_build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ export CONDA_BLD_PATH=~/conda-bld

conda build conda.recipe/

anaconda upload -u nrel $(conda build conda.recipe/ --output)
anaconda upload -u nlr $(conda build conda.recipe/ --output)

echo "Building and uploading conda package done!"
rm -rf $CONDA_BLD_PATH/*
Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@

html_context = {
"display_github": True,
"github_user": "nrel",
"github_user": "natlabrockies",
"github_repo": "rex",
"github_version": "main",
"conf_py_path": "/docs/source/",
Expand Down
5 changes: 5 additions & 0 deletions docs/source/misc/examples.nlr_data.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
NLR Renewable Energy Resource Data
==================================

.. include:: ../../../examples/NLR_Data/README.rst
:start-line: 2
5 changes: 0 additions & 5 deletions docs/source/misc/examples.nrel_data.rst

This file was deleted.

2 changes: 1 addition & 1 deletion docs/source/misc/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Examples
========
.. toctree::

examples.nrel_data
examples.nlr_data
examples.nsrdb
examples.wind
examples.us_wave
Expand Down
40 changes: 20 additions & 20 deletions examples/HSDS/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,18 @@ Highly Scalable Data Service (HSDS)

`The Highly Scalable Data Service (HSDS)
<https://www.hdfgroup.org/solutions/highly-scalable-data-service-hsds/>`_ is a
cloud-optimized solution for storing and accessing HDF5 files, e.g. the NREL
wind and solar datasets. You can access NREL data via HSDS in a few ways. Read
cloud-optimized solution for storing and accessing HDF5 files, e.g. the NLR
wind and solar datasets. You can access NLR data via HSDS in a few ways. Read
below to find out more.

Note that raw NREL .h5 data files are hosted on AWS S3. In contrast, the files
Note that raw NLR .h5 data files are hosted on AWS S3. In contrast, the files
on HSDS are not real "files". They are just domains that you can access with
h5pyd or rex tools to stream small chunks of the files stored on S3. The
multi-terabyte .h5 files on S3 would be incredibly cumbersome to access
otherwise.

You can now use HSDS with ``xarray`` to open NREL datasets remotely! See the guide
`here <https://nrel.github.io/rex/misc/examples.xarray.html>`_ for details.
You can now use HSDS with ``xarray`` to open NLR datasets remotely! See the guide
`here <https://natlabrockies.github.io/rex/misc/examples.xarray.html>`_ for details.

Extra Requirements
------------------
Expand All @@ -24,26 +24,26 @@ You may need some additional software beyond the basic ``rex`` install to run th

.. code-block:: bash

pip install NREL-rex[hsds]
pip install NLR-rex[hsds]

NREL Developer API
------------------
NLR Developer API
-----------------

The easiest way to get started with HSDS is to get a developer API key via the
`NREL Developer Network <https://developer.nrel.gov/signup/>`_. Once you have
`NLR Developer Network <https://developer.nrel.gov/signup/>`_. Once you have
your API key, create an HSDS config file at ``~/.hscfg`` with the following
entries (make sure you update the ``hs_api_key`` entry):

.. code-block:: bash

# NREL dev api
# NLR dev api
hs_endpoint = https://developer.nrel.gov/api/hsds
hs_api_key = your_api_key_goes_here

You should then be able to access NREL hsds data using ``rex`` and ``h5pyd`` as
You should then be able to access NLR hsds data using ``rex`` and ``h5pyd`` as
per the `usage examples below
<https://nrel.github.io/rex/misc/examples.hsds.html#hsds-and-rex-usage-examples>`_.
Note that this API is hosted on an NREL server and will have limits on the
<https://natlabrockies.github.io/rex/misc/examples.hsds.html#hsds-and-rex-usage-examples>`_.
Note that this API is hosted on an NLR server and will have limits on the
amount of data you can access via HSDS. If you get a the ``OSError: Error
retrieving data: None`` errors, it's probably because you're hitting the public
IO limits. You can confirm this by trying to extract a very small amount of
Expand All @@ -62,15 +62,15 @@ If this simple query succeeds while larger data slices fail, it is almost defini
Setting up a Local HSDS Server
------------------------------

Setting up an HSDS server on an EC2 instance or your local machine isn't too hard. The instruction set here is intended to be comprehensive and followed *exactly*. Most of these instructions are adapted from the `HSDS Repository <https://github.com/HDFGroup/hsds>`_ and the `h5pyd repository <https://github.com/HDFGroup/h5pyd>`_, but this tutorial is intended to be comprehensive and regularly maintained for NREL use. Please note the minor differences in the Unix- and Windows-specific instructions below and be sure to follow these subtleties exactly!
Setting up an HSDS server on an EC2 instance or your local machine isn't too hard. The instruction set here is intended to be comprehensive and followed *exactly*. Most of these instructions are adapted from the `HSDS Repository <https://github.com/HDFGroup/hsds>`_ and the `h5pyd repository <https://github.com/HDFGroup/h5pyd>`_, but this tutorial is intended to be comprehensive and regularly maintained for NLR use. Please note the minor differences in the Unix- and Windows-specific instructions below and be sure to follow these subtleties exactly!

Make sure you have python 3.x (we recommend 3.10), pip, and git installed. We find it easiest to manage your HSDS environment by installing `miniconda <https://docs.conda.io/en/latest/miniconda.html>`_ and creating a clean HSDS environment. Once you have that setup, follow these instructions:

#. In your shell, install nrel-rex >= v0.2.88 using pip, making sure to include the optional HSDS dependency:
#. In your shell, install nlr-rex >= v0.2.88 using pip, making sure to include the optional HSDS dependency:

.. code-block:: bash

pip install "nrel-rex[hsds]>=0.2.88"
pip install "nlr-rex[hsds]>=0.2.88"

#. Set your environment variables (if using windows, use ``set`` instead of ``export``) (this has to be done every time you login to a shell unless you set these in your ``.bashrc``):

Expand Down Expand Up @@ -113,14 +113,14 @@ Make sure you have python 3.x (we recommend 3.10), pip, and git installed. We fi
with h5pyd.Folder('/nrel/') as f:
print(list(f))

#. Assuming you see a list of NREL public dataset directories (e.g. ``['nsrdb', 'wtk', ...]``, congratulations! You have setup HSDS and h5pyd correctly.
#. Assuming you see a list of NLR public dataset directories (e.g. ``['nsrdb', 'wtk', ...]``, congratulations! You have setup HSDS and h5pyd correctly.

HSDS and rex Usage Examples
---------------------------

Now that you have an HSDS server running locally and h5pyd set up, you can
access NREL data as if you were on the NREL supercomputer. First, start by
browsing the NREL HSDS data offerings by exploring the HSDS folder structure:
access NLR data as if you were on the NLR supercomputer. First, start by
browsing the NLR HSDS data offerings by exploring the HSDS folder structure:

.. code-block:: python

Expand All @@ -138,4 +138,4 @@ These commands can also be run by using the HSDS CLI utility: ``$ hsls /nrel/``.

Once you find a file you want to access, you can use the ``rex`` utilities to
read the data. See the docs page `here
<https://nrel.github.io/rex/misc/examples.nrel_data.html>`_ for more details.
<https://natlabrockies.github.io/rex/misc/examples.nlr_data.html>`_ for more details.
Loading
Loading