Installation

JADE can be installed on your computer or HPC. If trying to install it on your computer, you can choose to install it in a conda environment or Docker container.

Computer or HPC with conda

  1. Choose a virtual environment in which to install JADE. This can be an existing conda environment or an environment from something like pyenv. A validated conda environment is provided in the JADE repository.

    Note that Python 3.7 or greater is required.

    Example with a new conda environment:

$ conda create --name jade python=3.7

  1. Install JADE.

    1. pip install NREL-jade or

    2. conda install nrel-jade --channel=nrel --channel=conda-forge

Computer with docker

Docker can run on different OS platforms - Linux, Mac, Windows, etc. Please follow the document https://docs.docker.com/ to install Docker CE on your machine first. Then you can continue JADE installation with docker.

Here are instructions to build a container with JADE installed.

  1. Clone JADE source code to your machine.

$ git clone git@github.com:NREL/jade.git

  1. Build jade docker image

$ docker build -t jade .

  1. Run jade docker container

$ docker run --rm -it -v absolute-input-data-path:/data jade

After the container starts, the terminal will show something like this

(jade) root@d14851e20888:/data#

Then type jade to show JADE related commands

(jade) root@d14851e20888:/data# jade

Usage: jade [OPTIONS] COMMAND [ARGS]...

  JADE commands

Options:
  --help  Show this message and exit.

Commands:
  auto-config   Automatically create a configuration.
  config        Manage a JADE configuration.
  extensions    Manage JADE extensions.
  pipeline      Manage JADE execution pipeline.
  show-events   Shows the events after jobs run.
  show-results  Shows the results of a batch of jobs.
  stats         View stats from a run.
  submit-jobs   Submits jobs for execution, locally or on HPC.

This base image is https://hub.docker.com/r/continuumio/miniconda3, which is built on top of debian, so you can use Linux commands for operation.

  1. To exit docker environment, just type

$ exit

For more about docker commands, please refer https://docs.docker.com/engine/reference/commandline/docker/.