Installation

Python environment

It's recommended to create a Python virtual environment deciated for PIPES CLI. Multiple tools could be used to create the environment, such as virtualenv, conda, pipenv, etc., you can choose one based on your own preference.

Here, we use Python's venv module to create such a virtual environment. After getting into your project directory, you can run the command below:

$ python3 -m venv .venv

Then activate the virtual environment,

$ source .venv/bin/activate

CLI installation

Please make sure your virtual environment has been activated before installing the PIPES CLI tool. Next, you can install the CLI from the source repository by running this command:

$ pip install git+https://github.com/nrel-pipes/nrel-pipes.git

To verify the installation by running:

$ pipes --version

If a version number pops up, that means the CLI tool is installed in your environment successfully.

Info

The CLI client is under development, if any updates, people needs to re-install to get the latest feature support, to re-install the CLI client as below:

$ pip install git+https://github.com/nrel-pipes/nrel-pipes.git --no-cache-dir --force-reinstall

Config, login, & ping

After having PIPES CLI installed, you need to configure the CLI and then login before starting to use it.

config

Run the following command to intialize the configuration on your machine,

$ pipes config init

Accordingly, the PIPES config file .pipes/config would be created within your home directory.

Optionally, if you want to learn more about what the configuration is, run the command below:

$ pipes config show

The configuration at your local looks like this:

{
  "pipes_server": "<pipes-api-server>",
  "pipes_cognito": "<aws-cognito-id>",
  "pipes_username": "<your-email-address>",
  "pipes_password": "<your-password>"
}

This is one-time job, you do not need to configure it when using PIPES CLI next time.

login

With the configuration complete, you can login:

$ pipes login

A message displaying "Login success!" confirms that you have successfully logged in. You can then begin your journey with PIPES.

Upon login, a session with a 12-hour lifespan will be created. After this period, you will be prompted to login again. This is intentionally designed for security consideration.

ping

To test the PIPES service status, you can ping the server:

$ pipes server ping

If the response message shows pong, which you are all set and good to go!

Technical support

If there is anything wrong, please feel free to Contact Us for technical support.