| General Server State | |
|---|---|
| Creates a server object that can be passed into other functions for making requests to the PEcAn API | |
| Pings the PEcAn API server to see if it is live | |
| Gets general information about PEcAn & the details of the database host | |
| Searching & Retrieving PEcAn Data | |
| Search for PEcAn Models from the database | |
| Get details of PEcAn Model from the database using model id | |
| Search for PEcAn Sites from the database | |
| Get details of PEcAn Site from the database using site id | |
| Search for PEcAn PFTs from the database | |
| Get details of PEcAn PFT from the database using PFT id | |
| Search for PEcAn Models from the database | |
| Get details of PEcAn Model from the database using model id | |
| Search for PEcAn Models from the database | |
| Download & save the desired input file | |
| PEcAn Workflows | |
| Get list of PEcAn Workflows from the database | |
| Get the details of a particular PEcAn workflow using the workflow ID | |
| Submit a PEcAn workflow using various user-defined parameters Hits the  | |
| Submit an XML file as a PEcAn workflow & obtain the workflow_id | |
| Submit a JSON file as a PEcAn workflow & obtain the workflow_id | |
| Submit a bunch of PEcAn workflows, the details of which are mentioned in CSV file | |
| Get the status of a particular PEcAn workflow using the workflow ID | |
| Download & save the desired file for a workflow | |
| PEcAn Runs | |
| Get list of PEcAn Runs that belong to a specific workflow | |
| Get the details of a particular PEcAn run using the run ID | |
| Download & save the desired input file for a run | |
| Download & save the desired output file for a run | |
| Plot the desired variables from the results of a PEcAn run | |
| Internal Functions | |
| Get the model ID from the exact name & revision | |
| Get the time taken for a workflow to reach its current state from the time it started execution | |