Metadata-Version: 2.1
Name: NREL-sup3r
Version: 0.0.0
Summary: Super Resolving Renewable Resource Data (sup3r)
Home-page: https://github.com/NREL/sup3r
Author: Ryan King
Author-email: ryan.king@nrel.gov
License: BSD 3-Clause
Keywords: sup3r
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
License-File: LICENSE
Requires-Dist: matplotlib (>=3.1)
Requires-Dist: NREL-rex (>=0.2.71)
Requires-Dist: NREL-phygnn (>=0.0.20)
Requires-Dist: NREL-rev
Requires-Dist: pytest (>=5.2)
Requires-Dist: tensorflow (>2.4)
Requires-Dist: xarray
Requires-Dist: netcdf4 (>=1.5.8)
Requires-Dist: dask
Provides-Extra: dev
Requires-Dist: flake8 ; extra == 'dev'
Requires-Dist: pre-commit ; extra == 'dev'
Requires-Dist: pylint ; extra == 'dev'

#################
Welcome to SUP3R!
#################

.. image:: https://github.com/NREL/sup3r/workflows/Documentation/badge.svg
    :target: https://nrel.github.io/sup3r/

.. image:: https://github.com/NREL/sup3r/workflows/Pytests/badge.svg
    :target: https://github.com/NREL/sup3r/actions?query=workflow%3A%22Pytests%22

.. image:: https://github.com/NREL/sup3r/workflows/Lint%20Code%20Base/badge.svg
    :target: https://github.com/NREL/sup3r/actions?query=workflow%3A%22Lint+Code+Base%22

.. image:: https://img.shields.io/pypi/pyversions/NREL-sup3r.svg
    :target: https://pypi.org/project/NREL-sup3r/

.. image:: https://badge.fury.io/py/NREL-sup3r.svg
    :target: https://badge.fury.io/py/NREL-sup3r

.. image:: https://codecov.io/gh/nrel/sup3r/branch/main/graph/badge.svg?token=WQ95L11SRS
    :target: https://codecov.io/gh/nrel/sup3r

.. image:: https://zenodo.org/badge/253541811.svg
   :target: https://zenodo.org/badge/latestdoi/253541811

.. inclusion-intro

sup3r command line tools
========================

- `forward_pass <https://nrel.github.io/sup3r/_cli/forward_pass.html#forward_pass>`_
- `data_extract <https://nrel.github.io/sup3r/_cli/data_extract.html#data_extract>`_

Installing sup3r
================

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 sup3r``

2. Activate directory:
    ``conda activate sup3r``

3. Install sup3r:
    1) ``pip install NREL-sup3r`` or
    2) ``conda install nrel-sup3r --channel=nrel``

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

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

2. Create ``sup3r`` environment and install package
    1) Create a conda env: ``conda create -n sup3r``
    2) Run the command: ``conda activate sup3r``
    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 ``sup3r`` and its dependencies by running:
       ``pip install .`` (or ``pip install -e .`` if running a dev branch
       or working on the source code)

Recommended Citation
====================

Update with current version:

Brandon Benton, Grant Buster, Andrew Glaws, Ryan King. Super Resolution for
Renewable Resource Data (sup3r).
https://github.com/NREL/sup3r (version v0.0.0), 2022.


