Installation
This document covers installation and setup of the tool. The tool requires you to build a valid case in SAM, so if you haven’t already download and install SAM from here: https://sam.nrel.gov/download.html
Currently, the supported SAM version is 2022.11.21!
SAM can be installed on Windows, MAC, or Linux.
Installation
Requires python >= 3.8
Works on Windows and Linux x64 OSes.
Currently, there are issues running on macOS. Please see this issue for updates: https://github.com/FSEC-Photovoltaics/pvrpm-lcoe/issues/49
Recommended using pip: (Replace @master with the branch release name if you want a release version)
1# for latest development branch
2pip install git+https://github.com/FSEC-Photovoltaics/pvrpm-lcoe/@master
3
4# for specific version
5pip install pvrpm-lcoe==1.8.0
Using the wheel file downloaded from https://github.com/FSEC-Photovoltaics/pvrpm-lcoe/releases
1pip install wheel
2pip install pvrpm-x.x.x-py3-none-any.whl
Manually:
1git clone https://github.com/FSEC-Photovoltaics/pvrpm-lcoe
2cd pvrpm-lcoe
3python setup.py install
If you want to build the documentation:
1git clone https://github.com/FSEC-Photovoltaics/pvrpm-lcoe
2cd pvrpm-lcoe
3pip install .[docs]
4cd docs
5make html
If you want to run automated tests (will take a while based on compute power):
1git clone https://github.com/FSEC-Photovoltaics/pvrpm-lcoe
2cd pvrpm-lcoe
3pip install .[testing]
4pytest
For setting up the package in edit mode to modify PVRPM for fixing bugs or adding features:
1git clone https://github.com/FSEC-Photovoltaics/pvrpm-lcoe
2cd pvrpm-lcoe
3pip install -e .
Edits to the code can be made in the pvrpm-lcoe folder and be tested by running PVRPM from the command line or custom wrapper script.