Getting started
Create account
If you're interested in using PIPES for your integrated modeling project and would like to explore its features, you can register for a PIPES account at: https://pipes.nrel.gov/register
After registration, a confirmation code will be sent to the email address you provided. Once confirmed, your account will be created and activated in PIPES, and you can log in.
If you encounter any issues with the PIPES account registration, please contact us at pipes@nrel.gov
Access methods
After your account setup done, you would be able to login to PIPES and access the services.
To interacte with PIPES, you can choose the react Web and/or CLI to interact with PIPES.
Please refer to the following sections for more guidance.
At this stage, the CLI is the primary method for managing project metadata using TOML.
The Web UI currently supports limited project operations, but more features are under development,
and will be available soon.
Create a project
Option 1: Create Project via CLI
After the account and CLI tool are setup, you can create a project in PIPES system. Get a copy of the
example project in TOML format, rename the project, then run the command below to create the project in PIPES.
After run the command, you will see the messages output on terminal console regarding to the project creation.
Warning
The project name in PIPES must be unique. If you attempt to create a project with a name that already exists, an error will be raised. You'll need to rename the project and try again.
After project created, you can run CLI commands the pull the project information or go to view on the Web page.
Option 2: Create Project via UI
Login to your PIPES account, go to the Create Project page, then follow the multi-step forms guidance to complete the project creation.