Code Monkey home page Code Monkey logo

rex's Introduction

Welcome to The REsource eXtraction (rex) tool!

Docs Tests Linter PyPi PythonV Conda Licence CodeCov Zeonodo

rex command line tools

Using Eagle Env

If you would like to run rex on Eagle (NREL's HPC) you can use a pre-compiled conda env:

conda activate /shared-projects/rev/modulefiles/conda/envs/rev/

or

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 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 you will also need to install h5pyd manually: pip install h5pyd

Option 2: Clone repo (recommended for developers)

  1. from home dir, git clone [email protected]: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.

rex's People

Contributors

mrossol avatar grantbuster avatar ppinchuk avatar bnb32 avatar ssolson avatar dimak415 avatar psusmars avatar ryancoe avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.