Skip to main content

National Renewable Energy Laboratory's (NREL's) Renewable Energy Potential(V) eXchange Tool: reVX

Project description

Docs Tests Linter PythonV PyPi Codecov Zenondo

reVX command line tools

Installing reVX

NOTE: The installation instruction below assume that you have python installed on your machine and are using conda as your package/environment manager.

  1. Create a new environment:

    conda create --name revx python=3.11

  2. Activate your new environment:

    conda activate revx

  3. Clone the repo:

    From your home directory /home/{user}/ or another directory that you have permissions in, run the command git clone git@github.com:NREL/reVX.git and then go into your cloned repository: cd reVX

  4. Install reVX:
    1. Follow the installation commands installation process that we use for our automated test suite here. Make sure that you call pip install --no-build-isolation -e . from within the cloned repository directory e.g. /home/{user}/reVX/. Don’t forget to run pip install --upgrade setuptools, especially if you run into any build errors.

      • NOTE: If you install using pip and want to run exclusion setbacks you will need to install rtree manually:
      • NOTE: If you install using pip and want to run shadow flicker exclusions, make sure you:
        • Use Python 3.10 or 3.11: conda create --name revx python=3.11

        • Install the flicker dependency: pip install -e .[flicker]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nrel_revx-0.5.3.tar.gz (263.0 kB view details)

Uploaded Source

Built Distribution

nrel_revx-0.5.3-py3-none-any.whl (315.3 kB view details)

Uploaded Python 3

File details

Details for the file nrel_revx-0.5.3.tar.gz.

File metadata

  • Download URL: nrel_revx-0.5.3.tar.gz
  • Upload date:
  • Size: 263.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for nrel_revx-0.5.3.tar.gz
Algorithm Hash digest
SHA256 d217410f2eb5b330582dc46ab09781ab88c15dc353a8e6ec0e38bc4e8168ec76
MD5 ef67a9900385ac81e0bfc1fd93e1afee
BLAKE2b-256 c2dda23e7ed19a622538de2b02a0920610d1b68ebc60891451f5bdbaea8a762a

See more details on using hashes here.

Provenance

The following attestation bundles were made for nrel_revx-0.5.3.tar.gz:

Publisher: publish_to_pypi.yml on NREL/reVX

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file nrel_revx-0.5.3-py3-none-any.whl.

File metadata

  • Download URL: nrel_revx-0.5.3-py3-none-any.whl
  • Upload date:
  • Size: 315.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for nrel_revx-0.5.3-py3-none-any.whl
Algorithm Hash digest
SHA256 7d9f0a29f92c5eff3d0dbbb9f45b921165fa840972228b7c37169fbf0cd6f612
MD5 718712ab7910574131f07631f43fa8b5
BLAKE2b-256 b891bafcd707b3fc711646c4caccbe76e6f705880b79954b55f37dfe4f0c0192

See more details on using hashes here.

Provenance

The following attestation bundles were made for nrel_revx-0.5.3-py3-none-any.whl:

Publisher: publish_to_pypi.yml on NREL/reVX

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page