search

FSEC-Photovoltaics / pvrpm-lcoe

PV Simulation using SAM and Python
BSD 3-Clause "New" or "Revised" License
8 stars 2 forks source link

DOC: Document public API #52

Closed SarthakJariwala closed 2 years ago

SarthakJariwala commented 2 years ago

The API section in the docs is empty. If the API listed there isn't supposed to be public API, I would recommend not listing it there.

As I understand, pvrpm is intended to be used from the command line (and not imported as a module), and as such, commands run, verify sim are the public API. I would suggest documenting those commands in more detail (see #50).

brandons209 commented 2 years ago

Huh, odd, was showing up fine locally. I'll fix it. Also, PVRPM can be used from both the command line and imported as modules. to manually setup and run a case with your own wrapper scripts.

brandons209 commented 2 years ago

Fixed in 4899e72e970b94dcf715e760ba2e0a2aebf553a2