Ctrl+K

Installation#

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

  1. Clone the gaps repository.

    • Using ssh: git clone git@github.com:NREL/gaps.git

    • Using https: git clone https://github.com/NREL/gaps.git

  2. Create and activate the gaps environment and install the package:

    1. Create a conda env: conda create -n gaps python=3.10

    2. Activate the newly-created conda env: conda activate gaps

    3. Change directories into the repository: cd gaps

    4. Prior to running pip below, make sure the branch is correct (install from main!): git branch -vv

    5. Install gaps and its dependencies by running: pip install -e . (or pip install -e .[dev] if running a dev branch or working on the source code)