Usage

Command line usage for PVRPM:

 1$ pvrpm --help
 2  Usage: pvrpm [OPTIONS] COMMAND [ARGS]...
 3
 4    Perform cost modeling for PV systems using SAM and PVRPM
 5
 6  Options:
 7    --help  Show this message and exit.
 8
 9  Commands:
10    run     Run the PVRPM LCOE cost model for the case
11    sim     Load the SAM case and test the basic SAM simulation
12    verify  Verify the case and pvrpm configuration files

Verify configuration:

 1$ pvrpm verify --help
 2  Usage: pvrpm verify [OPTIONS] CONFIG
 3
 4    Verify the case and pvrpm configuration files
 5
 6  Options:
 7    --case <path>  Path to directory containing json export from SAM for the
 8                   case
 9    --help         Show this message and exit.
10
11$ pvrpm verify --case /path/to/case/jsons/ /path/to/config.yml
12  2022-02-23 13:30:06,142--INFO: Configuration verified successfully!

Run SAM simulation:

Mainly for debugging purposes.

 1$ pvrpm sim --help
 2  Usage: pvrpm sim [OPTIONS] CONFIG
 3
 4    Load the SAM case and test the basic SAM simulation
 5
 6    The config YAML file should specify module order of simulation
 7
 8  Options:
 9    --case <path>  Path to directory containing json export from SAM for the
10                   case
11    --verbose      Enable verbosity in SAM simulation
12    --help         Show this message and exit.
13
14$ pvrpm verify --case /path/to/case/jsons/ --verbose /path/to/config.yml
15  0.08 %  @ -1
16  0.16 %  @ -1
17  0.24 %  @ -1
18  0.32 %  @ -1
19  0.40 %  @ -1
20  0.48 %  @ -1
21  0.56 %  @ -1
22  0.64 %  @ -1
23  ...
24  99.76 %  @ -1
25  99.84 %  @ -1
26  99.92 %  @ -1

Run PVRPM simulation:

 1$ pvrpm run --help
 2  Usage: pvrpm run [OPTIONS] CONFIG
 3
 4  Run the PVRPM LCOE cost model for the case
 5
 6  The config YAML file should specify module order of simulation
 7
 8  Options:
 9  --case <path>                   Path to directory containing json export
10                                  from SAM for the case
11  --threads <num_threads>         Number of threads to use for paralized
12                                  simulations, set to -1 to use all CPU
13                                  threads
14  --realization, --realizations <num_realizations>
15                                  Set the number of realizations for this run,
16                                  overrides configuration file value
17  --results <path/to/results/folder>
18                                  Folder to use for saving the results,
19                                  overrides configuration file value
20  --trace                         Enable debug stack traces
21  --debug INTEGER                 Save simulation state every specified number
22                                  of days for debugging. Saved to results
23                                  folder specified
24  --noprogress                    Disable progress bars for realizations
25  --help
26
27$ pvrpm run --case /path/to/case/jsons/ --threads -1 --realizations 10 --trace /path/to/config.yml
28  2022-02-23 13:51:36,250--WARNING: Lifetime daily DC and AC losses will be overridden for this run.
29  2022-02-23 13:51:36,250--WARNING: There is a non-zero value in the fixed annual O&M costs input. These will be overwritten with the new values.
30  2022-02-23 13:51:36,250--WARNING: Degradation is set by the PVRPM script, you have entered a non-zero degradation to the degradation input. This script will set the degradation input to zero.
31  2022-02-23 13:51:36,252--INFO: Running base case simulation...
32  2022-02-23 13:52:24,146--INFO: Base case simulation took: 47.89 seconds
33
34  2022-02-23 13:56:35,089--INFO: Generating results...
35  2022-02-23 13:56:39,469--INFO: Graphs saved to /path/to/results/
36  2022-02-23 13:56:43,264--INFO: Results saved to /path/to/results/