Metadata-Version: 2.1
Name: NREL-rex
Version: 0.2.47
Summary: National Renewable Energy Laboratory's (NREL's) REsource eXtraction tool: rex
Home-page: https://nrel.github.io/rex/
Author: Michael Rossol
Author-email: michael.rossol@nrel.gov
License: BSD 3-Clause
Description: **********************************************
        Welcome to The REsource eXtraction (rex) tool!
        **********************************************
        
        .. image:: https://github.com/NREL/rex/workflows/Documentation/badge.svg
            :target: https://nrel.github.io/rex/
        
        .. image:: https://github.com/NREL/rex/workflows/Pytests/badge.svg
            :target: https://github.com/NREL/rex/actions?query=workflow%3A%22Pytests%22
        
        .. 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
        
        .. image:: https://img.shields.io/pypi/pyversions/NREL-rex.svg
            :target: https://pypi.org/project/NREL-rex/
        
        .. image:: https://badge.fury.io/py/NREL-rex.svg
            :target: https://badge.fury.io/py/NREL-rex
        
        .. image:: https://anaconda.org/nrel/nrel-rex/badges/version.svg
            :target: https://anaconda.org/nrel/nrel-rex
        
        .. image:: https://anaconda.org/nrel/nrel-rex/badges/license.svg
            :target: https://anaconda.org/nrel/nrel-rex
        
        .. image:: https://codecov.io/gh/nrel/rex/branch/master/graph/badge.svg?token=WQ95L11SRS
            :target: https://codecov.io/gh/nrel/rex
        
        .. image:: https://mybinder.org/badge_logo.svg
            :target: https://mybinder.org/v2/gh/NREL/rex/master
        
        .. 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/rex/rex.resource_extraction.resource_cli.html#rex>`_
        - `NSRDBX <https://nrel.github.io/rex/rex/rex.resource_extraction.nsrdb_cli.html#nsrdbx>`_
        - `WINDX <https://nrel.github.io/rex/rex/rex.resource_extraction.wind_cli.html#windx>`_
        - `WaveX <https://nrel.github.io/rex/rex/rex.resource_extraction.wave_cli.html#wavex>`_
        - `MultiYearX <https://nrel.github.io/rex/rex/rex.resource_extraction.multi_year_resource_cli.html#multiyearx>`_
        - `rechunk <https://nrel.github.io/rex/rex/rex.rechunk_h5.rechunk_cli.html#rechunk>`_
        - `temporal-stats <https://nrel.github.io/rex/rex/rex.temporal_stats.temporal_stats_cli.html#temporal-stats>`_
        
        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 /datasets/modulefiles/conda_env
        
        or
        
        .. code-block:: bash
        
            source activate /datasets/modulefiles/conda_env
        
        .. or module:
        
        .. .. code-block:: bash
        
        ..     module use /datasets/modulefiles
        ..     module load rex
        
        .. **NOTE: Loading the rex module can take several minutes**
        
        Installing rex
        ==============
        
        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 https://github.com/NREL/rex.git``
            1) enter github username
            2) enter github password
        
        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 master!)
            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``
                - ``NSRDB``
                - ``WIND``
                - ``rechunk``
        
        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.
        
Keywords: rex
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.7
Provides-Extra: test
Provides-Extra: dev
